Sphinx文档写作与管理教程
1. 使用Sphinx进行文档组织
1.1. 文档制作简介
1.2. Sphinx简明教程
1.3. sphinx配置
1.4. 编辑 reStructuredText
1.5. Sphinx重要扩展介绍
1.6. 版本控制系统Git教程
1.7. 参考文献
1.8. 参考文献2
2. 使用 reStructuredText
2.1. ReST基础语法
2.2. 表格
2.3. 超链接与文件引用
2.4. 图片与视频
2.5. Rest文档规范
3. Sphinx中的角色与指令
3.1. rst的指令和角色(directive and role)
3.2. 代码高亮
3.3. 特殊提示
3.4. 渲染数学公式
3.5. Sphinx 中的不同引用方式
3.6. 数学公式
3.7. Sphinx中功能的扩展开发
4. Sphinx笔记
4.1. API手册制作指南
4.2. Sphinx 生成 PDF
4.3. 发布网站到GitHub
4.4. MyST
4.5. Reference
4.6. 发布静态网站
4.7. 问题集锦
5. 文档处理要求说明
5.1. Sphinx文档项目配置
5.2. Sphinx文档修改要求
6. 常用工具
6.1. 使用Pandoc进行文档转换
.rst
.pdf
5.
文档处理要求说明
¶
5.1. Sphinx文档项目配置
5.1.1. 配置
5.2. Sphinx文档修改要求
5.2.1. Sphinx文档项目
5.2.2. 常规内容修改说明
5.2.3. 单个文件中的标题使用
5.2.4. 表格
5.2.5. 图片
5.2.6. 脚注
5.2.7. 参考引用
previous
4.7.
问题集锦
next
5.1.
Sphinx文档项目配置