mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Xiangxu-0103 e1f61252d4
[Docs] fix typo (#841) 
* Update README.md

* Update index.rst
 		2022-12-20 15:45:15 +08:00
..
en [Docs] Translate registry.md (#817) 2022-12-13 15:59:04 +08:00
resources/config [Docs] Refine config docs. (#432) 2022-08-30 18:39:19 +08:00
zh_cn [Docs] fix typo (#841) 2022-12-20 15:45:15 +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