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 30fe410b17
[Docs] Temporarily skip errors in building pdf docs at readthedocs (#928) 
* temporarily skip readthedocs errors in building pdf docs

* fix error links

* remove useless links

* fix

* fix broken links as github url

* Update docs/zh_cn/notes/contributing.md

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2023-02-14 16:55:35 +08:00
..
en
[Docs] Temporarily skip errors in building pdf docs at readthedocs (#928)
2023-02-14 16:55:35 +08:00
resources/config
[Enhance] Substitute the environment variable in config file (#744)
2023-02-01 10:16:47 +08:00
zh_cn
[Docs] Temporarily skip errors in building pdf docs at readthedocs (#928)
2023-02-14 16:55:35 +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