同步操作将从 MindSpore/docs 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
This project provides the source files of the installation guide, tutorials, and other documents, as well as API configurations on the MindSpore official website https://www.mindspore.cn.
You are welcome to contribute documents. If you want to contribute documents, read the CONTRIBUTING_DOC.md. Please comply with the document writing specifications, and submit documents according to the process rules. After the documents are approved, the changes will be displayed in the document project and on the official website.
If you have any comments or suggestions on the documents, submit them in Issues.
docs
├───api // Configuration files for API generation.
│
├───docs // Technical documents about architecture, network list, operator list, and so on.
│
├───install // Installation guide.
│
├───resource // Resource-related documents.
│
├───tutorials // Tutorial-related documents.
│
└───README.md // Docs repository description.
MindSpore tutorials and API documents can be generated by Sphinx. The following uses the API document as an example to describe the procedure, and ensure that MindSpore, MindInsight and MindArmour have been installed.
git clone https://gitee.com/mindspore/docs.git
requirements.txt
file.
cd docs/api
pip install -r requirements.txt
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 theimport mindinsight
andimport mindarmour
statements, and then perform this step.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。