mmengine/docs
Range King bced7d6ef0
[Doc] fix typos in EN contributing.md (#792)
2022-12-06 17:39:03 +08:00
..
en [Doc] fix typos in EN contributing.md (#792) 2022-12-06 17:39:03 +08:00
resources/config [Docs] Refine config docs. (#432) 2022-08-30 18:39:19 +08:00
zh_cn [Docs] Translate migration docs of model (#728) 2022-12-06 17:22:02 +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