From ac22ad9fa091dffab93d45dc4f0477df1cedb16b Mon Sep 17 00:00:00 2001 From: Ting Wang Date: Fri, 5 Jun 2020 10:52:19 +0800 Subject: [PATCH] update README for docs description and api generation Signed-off-by: Ting Wang --- README.md | 9 +++++---- README_CN.md | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fe8f90ff..e1411c5f 100644 --- a/README.md +++ b/README.md @@ -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. ## License diff --git a/README_CN.md b/README_CN.md index b65ca489..cafa861e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -20,7 +20,7 @@ docs ├───api //用于生成API的相关配置文件 │ -├───docs //介绍文档 +├───docs //架构、网络和算子支持等技术文档 │ ├───install //安装指南 │ @@ -33,21 +33,22 @@ docs ## 文档构建 -MindSpore的教程和API文档均可由[Sphinx](https://www.sphinx-doc.org/en/master/)工具生成。下面以API文档为例介绍具体步骤。 +MindSpore的教程和API文档均可由[Sphinx](https://www.sphinx-doc.org/en/master/)工具生成。下面以API文档为例介绍具体步骤，操作前需完成MindSpore、MindInsight和MindArmour的安装。 1. 下载MindSpore Docs仓代码。 ```shell git clone https://gitee.com/mindspore/docs.git ``` -2. 进入docs目录，安装该目录下```requirements.txt```文件中的依赖项。 +2. 进入api目录，安装该目录下`requirements.txt`文件中的依赖项。 ```shell cd docs/api pip install -r requirements.txt ``` -3. 在docs目录下执行如下命令，完成后会新建build_zh_cn/html目录，该目录中存放了生成后的文档网页，打开```build_zh_cn/html/index.html```即可查看API文档内容。 +3. 在api目录下执行如下命令，完成后会新建`build_zh_cn/html`目录，该目录中存放了生成后的文档网页，打开`build_zh_cn/html/index.html`即可查看API文档内容。 ``` make html ``` + > 如仅需生成MindSpore API，请先修改`source_zh_cn/conf.py`文件，注释`import mindinsight`和`import mindarmour`语句后，再执行此步骤。 ## 版权 -- GitLab