mmyolo/docs
Lum 65663d5e4d
[Docs] Fixed the wrong url. (#764)
* [Docs] Fixed the wrong url.

* Update docs/zh_cn/get_started/article.md

Co-authored-by: Range King <RangeKingHZ@gmail.com>

* Fixed the pre-commit problem.

---------

Co-authored-by: Range King <RangeKingHZ@gmail.com>
2023-05-15 11:01:24 +08:00
..
en Add 15_minutes_object_detection.ipynb (#632) 2023-05-15 11:00:54 +08:00
zh_cn [Docs] Fixed the wrong url. (#764) 2023-05-15 11:01:24 +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