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
Zaida Zhou 458f6d684e
[Docs] Refactor docs structure (#494) 
* [WIP] Refactor-docs-structure

* [Docs] Check link and fix rst  (#498)

* check link

* fix rst

* Fix conf.py

* Fix lint

* minor refine

* minor refine

* modify zh_readme and index.rst

* add migration exampls get_started design to en

* add tutorials to en

* correct chinese doc link

* Apply suggestions from code review

* Update docs/en/advanced_tutorials/distributed.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
2022-08-31 21:18:55 +08:00
..
en
[Docs] Refactor docs structure (#494)
2022-08-31 21:18:55 +08:00
resources/config
[Docs] Refine config docs. (#432)
2022-08-30 18:39:19 +08:00
zh_cn
[Docs] Refactor docs structure (#494)
2022-08-31 21:18:55 +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