# MindSpore文档

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

[View English](./README.md)

## 简介

此工程提供MindSpore官方网站<https://mindspore.cn>所呈现安装指南、教程、文档的源文件以及API的相关配置。

## 贡献

我们非常欢迎您贡献文档！如果想要参与，请阅读[CONTRIBUTING_DOC_CN.md](./CONTRIBUTING_DOC_CN.md)，务必遵守文档写作规范，并按照流程规则提交，审核通过后，改动会在文档工程和官网中呈现。

同时，如果您对文档有任何意见或建议，请在Issues中提交。

## 目录结构说明

```
docs
├───api //用于生成API的相关配置文件
│
├───docs //架构、网络和算子支持等技术文档
│      
├───install //安装指南
│      
├───resource //资源相关文档
│      
├───tutorials //教程相关文档
│      
└───README.md //Docs仓说明
```

## 文档构建

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. 进入api目录，安装该目录下`requirements.txt`文件中的依赖项。
   ```shell
   cd docs/api
   pip install -r requirements.txt
   ```
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`语句后，再执行此步骤。 

## 版权

- [Apache License 2.0](LICENSE)
- [Creative Commons License version 4.0](LICENSE-CC-BY-4.0)
