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 // Introduction to documents. │ ├───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.
git clone https://gitee.com/mindspore/docs.git
cd docs/api pip install -r requirements.txt
build_zh_cn/html/index.htmlto view the API document.