README.md 1.9 KB
Newer Older
C
chengxiao 已提交
1
# MindSpore Documents
L
leiyuning 已提交
2 3 4

![MindSpore Logo](resource/MindSpore-logo.png)

C
chengxiao 已提交
5 6
[查看中文](./README_CN.md)

L
leiyuning 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
## Overview

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>.

## Contributions

You are welcome to contribute documents. If you want to contribute documents, read the [CONTRIBUTING_DOC.md](./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.

## Directory Structure Description

```
docs
├───api // Configuration files for API generation.
L
leonwanghui 已提交
22

L
leiyuning 已提交
23
├───docs // Introduction to documents.
L
leonwanghui 已提交
24

L
leiyuning 已提交
25
├───install // Installation guide.
L
leonwanghui 已提交
26

L
leiyuning 已提交
27
├───resource // Resource-related documents.
L
leonwanghui 已提交
28

L
leiyuning 已提交
29
├───tutorials // Tutorial-related documents.
L
leonwanghui 已提交
30

L
leiyuning 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
└───README.md // Docs repository description.
```

## 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.

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.
   ```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.
   ```
   make html
   ```

## License

- [Apache License 2.0](LICENSE)
C
chengxiao 已提交
55
- [Creative Commons License version 4.0](LICENSE-CC-BY-4.0)