mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
liukuikun 1fea82aad5
[Docs] update data element tutorials (#431) 
* structure tutorials

* refine data element docs

* modify introduce

* fix comment

* fix comment

* fix comment
 		2022-08-31 20:39:08 +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] update data element tutorials (#431) 2022-08-31 20:39:08 +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