mirrors
/
mmengine
mirror of https://github.com/open-mmlab/mmengine.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Zaida Zhou 6c607bd26f
[Docs] Simplify hook docs (#428) 
* Move the design of hook to design/hook.md

* add relative links in docs

* update docstring of hooks

* refine checkpointhook docs

* refine

* fix comments

* refine

* add logging.md link in hook.md

* resolve comments

* fix typo
 		2022-08-23 16:20:47 +08:00
..
en [Feature] Profiling tools (#241) 2022-05-25 10:55:07 +08:00
zh_cn [Docs] Simplify hook docs (#428) 2022-08-23 16:20:47 +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