mmyolo/docs
tianlei 8973096d04
[Doc] Add EN get_started (#600)
* [Doc] Add get started EN

* add pre-commit

* Update installation.md

删除register_all_modules

* Delete article.md
2023-02-28 13:49:08 +08:00
..
en [Doc] Add EN get_started (#600) 2023-02-28 13:49:08 +08:00
zh_cn [Docs] Refine TTA Docs (#594) 2023-02-28 11:15:08 +08:00
README.md [Docs] Refactor zh-CN docs (#568) 2023-02-20 15:51:37 +08:00

README.md

Build Documentation

  1. Clone MMYOLO

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