贡献文档

View English

欢迎参与MindSpore文档贡献，符合要求的文档将会在MindSpore官网中呈现。

• 贡献文档
  • 新建或更新文档
  • 提交修改
  • 文档写作规范

新建或更新文档

本项目支持MarkDown和reStructuredText格式的内容贡献，对应地可创建.md和.rst为后缀的文档或修改已存在的文档。

提交修改

提交修改的步骤与代码相同，请参考代码贡献指南。

文档写作规范

• 标题仅支持Atx风格，标题与上下文需用空行隔开。

  # 一级标题
  
  ## 二级标题
  
  ### 三级标题

• 列表标题和内容如需换行显示，标题和内容间需增加一个空行，否则无法实现换行。

  - 标题
  
    内容。

• 目录中的锚点（超链接）只能使用中文、小写英文字母或“-”，不能带有空格或其他特殊字符，否则会导致链接无效。

• 注意事项使用“>”标识。

  > 注意事项内容。

• 参考文献需列举在文末，并在文中标注。

  引用文字或图片说明后，增加标注[编号]。
  
  ## 参考文献
  
  [1] 作者. [有链接的文献名](http://xxx).
  
  [2] 作者. 没有链接的文献名.

• 示例代码注释需遵循如下要求：

  • 注释用英文写作；
  • Python函数、方法、类的注释使用"""；
  • Python其他代码注释使用#；
  • C++代码注释使用//。

  """
  Python函数、方法、类的注释
  """
  
  # Python代码注释
  
  // C++代码注释
  

• 图和图标题前后需增加一个空行，否则会导致排版异常。正确举例如下：

  如下图所示：
  
  ![](./xxx.png)
  
  图1：xxx
  
  下文内容。

• 表格前后需增加一个空行，否则会导致排版异常。有序或无序列表内不支持表格。正确举例如下：

  ## 文章标题
  
  | 表头1   | 表头2
  | :-----  | :----
  | 内容I1  | 内容I2
  | 内容II1 | 内容II2
  
  下文内容。

• 教程、文档中引用接口、路径名、文件名等使用“` `”标注，如果是函数或方法，最后不加括号。举例如下：

  • 引用方法

    使用映射 `map` 方法。

  • 引用代码

    `batch_size`：每组包含的数据个数。

  • 引用路径

    将数据集解压存放到工作区`./MNIST_Data`路径下。

  • 引用文件名

    其他依赖项在`requirements.txt`中有详细描述。

• 教程、文档中待用户替换的内容需要额外标注，在正文中，使用“*”包围需要替换内容，在代码片段中，使用“{}”包围替换内容。举例如下：

  • 正文中

    需要替换你的本地路径*your_path*。

  • 代码片段中

    conda activate {your_env_name}