mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Evan f356b3c207
[Docs] Minor fixes in docs to remove or replace unicode chars with ascii chars (#1018) 
* Remove CN comments in EN docs code
* Replace some full-width unicode chars with half-width ascii chars
 		2023-03-26 13:59:26 +08:00
..
en [Docs] Minor fixes in docs to remove or replace unicode chars with ascii chars (#1018) 2023-03-26 13:59:26 +08:00
resources/config [Enhance] Substitute the environment variable in config file (#744) 2023-02-01 10:16:47 +08:00
zh_cn [Enhancement] Support dumping logs of different ranks (#968) 2023-03-13 14:35:31 +08:00
README.md [Docs] fix typo (#841) 2022-12-20 15:45:15 +08:00

README.md

Build Documentation

  1. Clone MMEngine

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

  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