[野火]sphinx文档规范与模版

为什么使用sphinx写文档

• 关于本项目
• 关于野火
• 快速参与本项目（提交bug或文档修改）
• TODO和悬赏任务

使用sphinx和vscode编写文档

• 1. sphinx的安装与使用
• 2. 使用vscode编写rst文件
• 3. docx批量转rst方法

reST语法

• 1. ReST基础语法
• 2. 超链接与文件引用
• 3. 代码高亮
• 4. 图片与视频
• 5. 数学符号和公式
• 6. 特殊提示
• 7. rst的指令和角色（directive and role）
• 8. 野火sphinx文档规范

使用markdown

• 1. 使sphinx支持markdown
• 2. Markdown示例

文档格式转换

• 使用pandoc进行文档转换

常见问题

• 常见问题

版权

• 版权说明