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
Mashiro fbd31d2041
[Docs] Refine config docs. (#432) 
* tmp commit

* refine docstring

* minor refine

* fix as comment

* add tutorial for merge_from_dict

* minor refine

* minor refine

* export md by jupyter

* temp add ipnb

* refine the docs

* remote ipynb

* fix as comment

* add change _base_.variable

* Fix as comment

* minor refine

* Fix as comment

* Fix as comment

* minor refine
2022-08-30 18:39:19 +08:00
..
en
[Docs] Make API of docs clearer (#469)
2022-08-30 16:27:20 +08:00
resources/config
[Docs] Refine config docs. (#432)
2022-08-30 18:39:19 +08:00
zh_cn
[Docs] Refine config docs. (#432)
2022-08-30 18:39:19 +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