使用 Sphinx

本指南旨在演示如何开始使用Sphinx，并涵盖从安装Sphinx和配置第一个Sphinx项目到使用Sphinx提供的一些现成高级功能的所有内容。如果您正在寻找有关扩展 Sphinx 的指导，请参阅 编写Sphinx扩展 .

• reStructuredText
  • reStructuredText 基础
  • 角色
  • 指令
  • 字段列表
• Markdown
  • 配置
• 交叉引用语法
  • 交叉引用任何内容
  • 交叉引用对象
  • 交叉引用任意位置
  • 交叉引用文档
  • 引用可下载文件
  • 按图号交叉引用图
  • 交叉引用其他感兴趣的项目
• 配置
  • 项目信息
  • 一般配置
  • 国际化的选择
  • 数学选项
  • HTML输出选项
  • 单个HTML输出选项
  • HTML帮助输出选项
  • Apple帮助输出选项
  • EPUB输出选项
  • Latex 输出选项
  • 文本输出选项
  • 手动页面输出选项
  • Texinfo输出选项
  • qthelp输出选项
  • 链接检查生成器的选项
  • XML生成器选项
  • C域的选项
  • C++域的选项
  • 用于Python域的选项
  • 用于Java Script域的选项
  • 配置文件示例
• Builders
  • StandaloneHTMLBuilder
  • DirectoryHTMLBuilder
  • SingleFileHTMLBuilder
  • HTMLHelpBuilder
  • QtHelpBuilder
  • AppleHelpBuilder
  • DevhelpBuilder
  • Epub3Builder
  • LaTeXBuilder
  • TextBuilder
  • ManualPageBuilder
  • TexinfoBuilder
  • SerializingHTMLBuilder
  • PickleHTMLBuilder
  • JSONHTMLBuilder
  • MessageCatalogBuilder
  • ChangesBuilder
  • DummyBuilder
  • CheckExternalLinksBuilder
  • XMLBuilder
  • PseudoXMLBuilder
  • 序列化生成器详细信息
• 领域
  • 基本标记
  • 内置域
  • 更多领域
• 扩展
  • 内置扩展
  • 第三方扩展
• HTML主题化
  • Builders
  • 主题
• 国际化
  • Sphinx国际化细节
  • 用Sphinx国际语翻译
  • 使用Transifex服务进行团队翻译
  • 使用Weblate服务进行团队翻译
  • 有助于Sphinx参考翻译
  • 翻译进度和统计
• Sphinx Web支持
  • Web支持快速入门
  • WebSupport类
  • 搜索适配器
  • 存储后端