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 09a195b24c
[Docs] Fix Chinese docs whitespaces (#521) 
* change pre-commit-config

* modify docs with pre-commit hook

* change pre-commit-config-zh-cn

* fallback readme.md

Co-authored-by: HAOCHENYE <21724054@zju.edu.cn>
2022-10-17 14:20:00 +08:00
..
en
Bump version to v0.2.0 (#591)
2022-10-11 23:08:17 +08:00
resources/config
[Docs] Refine config docs. (#432)
2022-08-30 18:39:19 +08:00
zh_cn
[Docs] Fix Chinese docs whitespaces (#521)
2022-10-17 14:20:00 +08:00
README.md
[Doc]: fix typo in installation command (#433)
2022-08-16 15:42:27 +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 -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