2. 使用Sphinx进行文档组织

使用sphinx编写的文档可以方便地制作html、pdf等格式，非常方便浏览和转换。

• 2.1. 安装与使用Sphinx
  • 2.1.1. 安装Sphinx
  • 2.1.2. 使用Sphinx
  • 2.1.3. 使用主题
• 2.2. Sphinx配置
  • 2.2.1. 项目信息
  • 2.2.2. 一般配置项
  • 2.2.3. 国际化选项
  • 2.2.4. 数学选项
  • 2.2.5. HTML输出选项
  • 2.2.6. EPUB输出配置项
  • 2.2.7. LaTeX输出配置项
  • 2.2.8. 文本输出选项
  • 2.2.9. HTML主题
  • 2.2.10. Markdown支持
  • 2.2.11. HTML模板
  • 2.2.12. sphinx扩展ext
• 2.3. Sphinx构建
  • 2.3.1. Makefile选项
  • 2.3.2. sphinx-build 用法
  • 2.3.3. 调用sphinx-apidoc
  • 2.3.4. 生成不同格式的文档
• 2.4. 编辑 reStructuredText
  • 2.4.1. Sublime Text及其安装
  • 2.4.2. 使用vscode编写rst文件
• 2.5. Sphinx重要扩展介绍
  • 2.5.1. Sphinx内置扩展
  • 2.5.2. 第三方扩展
  • 2.5.3. 推荐使用的第三方扩展
• 2.6. 常见问题集锦
  • 2.6.1. 中文问题
  • 2.6.2. 常用 reStructuredText 标记
  • 2.6.3. 如何使用原始的 html 标签
• 2.7. Sphinx 快速入门
  • 2.7.1. Sphinx 开发环境配置
  • 2.7.2. 第一个 Sphinx 项目
• 2.8. 支持的语法比较