@@ -20,7 +20,7 @@ If you have any comments or suggestions on the documents, submit them in Issues.
docs
├───api // Configuration files for API generation.
│
├───docs // Introduction to documents.
├───docs // Technical documents about architecture, network list, operator list, and so on.
│
├───install // Installation guide.
│
...
...
@@ -33,21 +33,22 @@ docs
## Document Construction
MindSpore tutorials and API documents can be generated by [Sphinx](https://www.sphinx-doc.org/en/master/). The following uses the API document as an example to describe the procedure.
MindSpore tutorials and API documents can be generated by [Sphinx](https://www.sphinx-doc.org/en/master/). The following uses the API document as an example to describe the procedure, and ensure that MindSpore, MindInsight and MindArmour have been installed.
1. Download code of the MindSpore Docs repository.
```shell
git clone https://gitee.com/mindspore/docs.git
```
2. Go to the docs directory and install the dependency items in the ```requirements.txt``` file.
2. Go to the api directory and install the dependency items in the `requirements.txt` file.
```shell
cd docs/api
pip install-r requirements.txt
```
3. Run the following command in the docs directory to create the build_zh_cn/html directory that stores the generated document web page. You can open ```build_zh_cn/html/index.html``` to view the API document.
3. Run the following command in the api directory to create the `build_zh_cn/html` directory that stores the generated document web page. You can open `build_zh_cn/html/index.html` to view the API document.
```
make html
```
> If you only need to generate the MindSpore API, please modify the `source_zh_cn/conf.py` file, comment the `import mindinsight` and `import mindarmour` statements, and then perform this step.
