mmengine/docs
Mashiro 4e685931d0
Bump version to v0.3.0 (#661)
* Bump version to v0.3.0

* minor refine

* Fix as comment

* Fix as comment

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-11-02 19:34:03 +08:00
..
en Bump version to v0.3.0 (#661) 2022-11-02 19:34:03 +08:00
resources/config [Docs] Refine config docs. (#432) 2022-08-30 18:39:19 +08:00
zh_cn [Docs] Fix docstring and documentation used for hub.get_model (#659) 2022-11-02 10:16:56 +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