mmengine/docs
Evan eb2dc671e9
[Docs] English introduction (#1189)
2023-06-06 18:45:59 +08:00
..
en [Docs] English introduction (#1189) 2023-06-06 18:45:59 +08:00
resources/config [Enhance] Substitute the environment variable in config file (#744) 2023-02-01 10:16:47 +08:00
zh_cn [Docs] Add the usage of clearml (#1180) 2023-06-01 21:54:30 +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