mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Tau d312bc40b0
[Doc] Refine chinese doc (#516) 
* refine chinese doc

* remove  in title

* Update docs/zh_cn/tutorials/param_scheduler.md

* fix link

* remove files from building docs

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: zhouzaida <zhouzaida@163.com>
 		2022-10-21 19:35:51 +08:00
..
en [Docs] Translate installation and 15_min (#629) 2022-10-19 10:51:16 +08:00
resources/config [Docs] Refine config docs. (#432) 2022-08-30 18:39:19 +08:00
zh_cn [Doc] Refine chinese doc (#516) 2022-10-21 19:35:51 +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