2022-08-15 11:47:08 +08:00
|
|
|
## 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
|
2022-08-16 15:42:27 +08:00
|
|
|
pip install -r requirements/docs.txt
|
2022-08-15 11:47:08 +08:00
|
|
|
```
|
|
|
|
|
|
|
|
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
|