[Docs] Add the steps to build docs (#409)

pull/429/head
Zaida Zhou 2022-08-15 11:47:08 +08:00 committed by GitHub
parent 3b1c45bb76
commit 26342f3586
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions

28
docs/README.md 100644
View File

@ -0,0 +1,28 @@
## Build Documentation
1. Clone MMEngine
```bash
git clone https://github.com/open-mmlab/mmengine.git
cd mmegnine
```
2. Install the building dependencies of documentation
```bash
pip install 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