mmengine/docs
Mashiro 7af68d1b5e
[Docs] Fix a link error in initialization tutorial (#843)
2022-12-23 12:17:08 +08:00
..
en [Docs] Fix a link error in initialization tutorial (#843) 2022-12-23 12:17:08 +08:00
resources/config [Docs] Refine config docs. (#432) 2022-08-30 18:39:19 +08:00
zh_cn [Docs] Translate optim_wrapper.md (#833) 2022-12-22 10:44:23 +08:00
README.md [Docs] fix typo (#841) 2022-12-20 15:45:15 +08:00

README.md

Build Documentation

  1. Clone MMEngine

    git clone https://github.com/open-mmlab/mmengine.git
    cd mmengine
    
  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