mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Mashiro 910778a94e
[Docs] Fix cannot show `changelog.md` in chinese documents. (#606) 
* [Fix] Fix error path of changelog.md in docs/zh_cn/index.rsts

* Fix stupid commit

* run bash script during build docs

* run bash script during build docs

* run bash script during build docs

* translate notes to 说明

* update auth
 		2022-10-14 16:56:34 +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 cannot show `changelog.md` in chinese documents. (#606) 2022-10-14 16:56:34 +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