mmengine/docs/README.md
Xiangxu-0103 e1f61252d4
[Docs] fix typo (#841)
* Update README.md

* Update index.rst
2022-12-20 15:45:15 +08:00

29 lines
449 B
Markdown

## Build Documentation
1. Clone MMEngine
```bash
git clone https://github.com/open-mmlab/mmengine.git
cd mmengine
```
2. Install the building dependencies of documentation
```bash
pip install -r requirements/docs.txt
```
3. Change directory to `docs/en` or `docs/zh_cn`
```bash
cd docs/en # or docs/zh_cn
```
4. Build documentation
```bash
make html
```
5. Open `_build/html/index.html` with browser