mmyolo/docs
Haian Huang(深度眸) e08e9895b0
[Docs] Add FAQ and Troubleshooting steps (#579)
* add FAQ

* update

* update

* update

* update

* update

* update
2023-02-23 16:38:08 +08:00
..
en [Docs] Add FAQ and Troubleshooting steps (#579) 2023-02-23 16:38:08 +08:00
zh_cn [Docs] Add FAQ and Troubleshooting steps (#579) 2023-02-23 16:38: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