mirrors/mmengine
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmengine.git synced 2025-06-03 21:54:44 +08:00
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Qian Zhao c712070c90
[Docs] Resolve warnings in sphinx build (#915) 
* add ZeroOptimizer to optim

* resolve `duplicate label` warnings

* upgrade docutils && shpinx to resolve `unknown directive or role` warnings

* fix typo

* resolve literal_block && heading warnings

* resolve json literal_block warnings

* resolve python literal_block warnings

* resolve bunches of reference warnings

* resolve bunches of docstring warnings

* resolve warnings in autosummary

* resolve remaining warnings in en docs

* resolve heading warnings in zh_cn docs

* resolve remaining warnings in zh_cn docs

* fix as comments

* fix as comments
2023-02-08 20:36:57 +08:00
..
en
[Docs] Resolve warnings in sphinx build (#915)
2023-02-08 20:36:57 +08:00
resources/config
[Enhance] Substitute the environment variable in config file (#744)
2023-02-01 10:16:47 +08:00
zh_cn
[Docs] Resolve warnings in sphinx build (#915)
2023-02-08 20:36:57 +08:00
README.md
[Docs] fix typo (#841)
2022-12-20 15:45:15 +08:00

README.md

Build Documentation

  1. Clone MMEngine

    git clone https://github.com/open-mmlab/mmengine.git
cd mmengine

  2. Install the building dependencies of documentation

    pip install -r requirements/docs.txt

  3. Change directory to docs/en or docs/zh_cn

    cd docs/en  # or docs/zh_cn

  4. Build documentation

    make html

  5. Open _build/html/index.html with browser