mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Zaida Zhou 26342f3586
[Docs] Add the steps to build docs (#409) 		2022-08-15 11:47:08 +08:00
..
en [Feature] Profiling tools (#241) 2022-05-25 10:55:07 +08:00
zh_cn [Fix]: fix mdformat version to support python3.6 (#315) 2022-06-21 16:32:58 +08:00
README.md [Docs] Add the steps to build docs (#409) 2022-08-15 11:47:08 +08:00

README.md

Build Documentation

  1. Clone MMEngine

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

  2. Install the building dependencies of documentation

    pip install 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