sphinx 写作模板 可以作为菜鸡的起步版本

# 使用说明 文档中心支持md和rst两种格式，优先推荐使用rst格式。当确定文档格式后，复制一份`Demo_doc`文件到自己的目录下，在`Demo_sample`中选`Demo_rst`或`Demo_md`文件修改自己的文档。 ## 1 使用rst进行文档构建 ### 1.1 Demo_rst目录结构说明 ``` ├── Demo_rst ├── content ├── source ├── conf.py #在此处改动文件名字 ├── index.rst #在此处更改对应的索引rst，同时更改标题和文档介绍 ├── logo.png #该处不进行改动 ├── statement.rst #该处不进行改动 ├── sample.rst #该处为文档主要内容 ├── _static ├── enflame_logo.png #该处不进行改动 ├── logo.png #该处不进行改动 ├── level1.png #该处不进行改动 ├── Makefile #该处不进行改动 ├── Makefile #该处不进行改动 ``` ### 1.2 Demo_rst开发流程 * 在conf.py中改动内容：修改文档名称、版本、更新日期、pdf文件名称等。  * 在index.rst中改动内容：文档标题及内容介绍，注意编译html时删除引用的statement.rst，编译pdf时保留。  * 执行make html 会在`source`目录下生成`build`文件夹，可查看对应的html文档 * 执行make pdf 会在`source`目录下生成`build`文件夹，可在latex文件中查看对应的pdf文档 编译需要在docker环境下运行 ### 1.3 Demo_rst常规语法汇总 rst常规语法参考：https://github.com/liuguoquan528/img/blob/main/rst%E6%96%87%E6%A1%A3%E8%AF%AD%E6%B3%95.rst ### 1.4 写作说明 * 必须按照模板样式进行文档组织。 * 模板中`statement.rst` 以及`source/logo.png` `source/_static/enflame_logo.png` `source/_static/level1.png` `source/_static/logo.png`要保留下来 ## 2 使用md进行文档构建 ### 2.1 md目录结构说明 ``` ├── Demo_md ├── content ├── source ├── conf.py #在此处改动文件名字 ├── index.rst #在此处更改对应的索引rst，同时更改标题和文档介绍 ├── logo.png #该处不进行改动 ├── statement.rst #该处不进行改动 ├── sample.md #该处为文档主要内容 ├── sample.rst #该处为文档主要内容 ├── _static ├── enflame_logo.png #该处不进行改动 ├── logo.png #该处不进行改动 ├── level1.png #该处不进行改动 ├── Makefile #该处不进行改动 ├── Makefile #该处不进行改动 ``` ### 2.2 Demo_md开发流程 * 在conf.py中改动内容：修改文档名称、版本、更新日期、pdf文件名称等。  * 在index.rst中改动内容：文档标题及内容介绍，注意编译html时删除引用的statement.rst，编译pdf时保留。  * 在sample.md中改动内容：编写md文件后需转成rst文件，且要在rst文件中修改成模版中的标题层级。正文中的图片请务必设置图片名称，表格请务必设置表名。 * 执行make html 会在`source`目录下生成`build`文件夹，可查看对应的html文档 * 执行make pdf 会在`source`目录下生成`build`文件夹，可在latex文件中查看对应的pdf文档 编译需要在docker环境下运行 ### 2.3 md常规语法汇总 md文档转rst注意事项：https://github.com/liuguoquan528/img/blob/main/md%E6%96%87%E6%A1%A3%E8%BD%ACrst%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md ### 2.4 写作说明 * 必须按照模板样式进行文档组织。 * 模板中`statement.rst` 以及`source/logo.png` `source/_static/enflame_logo.png` `source/_static/level1.png` `source/_static/logo.png`要保留下来