Sphinx文档写作管理
1. 使用Sphinx进行文档组织
1.1. 文档制作简介
1.2. 安装与使用Sphinx
1.3. sphinx配置
1.4. Sphinx构建
1.5. 编辑 reStructuredText
1.6. Sphinx重要扩展介绍
1.7. 常见问题集锦
2. reStructuredText 标识语法
2.1. ReST 文档结构语法
2.2. ReST 行内文本常用语法
2.3. 列表表示语法
2.4. 超链接Hyperlink Targets
2.5. Rest文本块
2.6. 特殊提示
2.7. 代码高亮
2.8. 添加图片
2.9. 表格
2.10. 使用数学表达式
3. Sphinx中的角色与指令
3.1. rst的角色和指令
3.2. 交叉引用
3.3. 脚注 Footnotes
3.4. 引文(文献引用)
3.5. 术语引用
4. Sphixn进阶及常用扩展模块
4.1. 数学表达式渲染方式
4.2. 在Sphinx中支持Markdown
4.3. 使用graphviz绘图
4.4. 使用PlantUML绘图
4.5. API手册制作指南
4.6. Sphinx中的国际化
4.7. Sphinx 生成 PDF
4.8. Sphinx中功能的扩展开发
5. 工具链与技术栈
5.1. Linux Shell 文本处理工具
5.2. 版本控制系统Git教程
5.3. Make工具介绍
5.4. 使用Pandoc进行文档转换
5.5. 发布网站到GitHub
5.6. 发布静态网站
6. Sphinx文档管理与编辑实践
6.1. Sphinx文档项目配置
6.2. Sphinx文档修改要求
6.3. RestructuredText 文档规范
7. 附录
7.1. 术语表
7.2. Reference
.rst
.pdf
4.
Sphixn进阶及常用扩展模块
¶
4.1. 数学表达式渲染方式
4.1.1. 添加插件
4.1.2. 使用MathJax渲染公式
4.1.3. 使用LaTex渲染公式
4.1.4. 使用KaTex渲染公式
4.1.5. 自定义数学命令
4.2. 在Sphinx中支持Markdown
4.2.1. MyST 与解析器
4.2.2. 在 Sphinx 中启用 Markdown 支持
4.3. 使用graphviz绘图
4.3.1. 安装graphviz
4.3.2. 修改项目配置文件
4.3.3. 画图
4.4. 使用PlantUML绘图
4.4.1. Installation
4.4.2. Usage
4.4.3. Configuration
4.5. API手册制作指南
4.5.1. 一个例子
4.5.2. 文档注释风格支持
4.5.3. 问题解决
4.6. Sphinx中的国际化
4.6.1. Sphinx internationalization details
4.6.2. Translating with sphinx-intl
4.6.3. 编译
4.6.4. 示例
4.7. Sphinx 生成 PDF
4.7.1. 编译生成 PDF
4.7.2. Debian/Ubuntu 操作系统下的使用
4.7.3. Windows 环境下的使用
4.8. Sphinx中功能的扩展开发
4.8.1. 域中有什么?
4.8.2. 自定义角色和指令
4.8.3. 参考配方
previous
3.5.
术语引用
next
4.1.
数学表达式渲染方式