使用 Sphinx¶
本指南用于演示如何开始使用 Sphinx,涵盖从安装 Sphinx 并配置您的第一个 Sphinx 项目到使用 Sphinx 提供的开箱即用的一些高级功能的所有内容。如果您正在寻找有关扩展 Sphinx 的指南,请参阅 拓展 Sphinx。
- 快速上手
- 安装 Sphinx
- reStructuredText
- Markdown
- 配置
- 项目信息
- 通用配置
- Options for internationalization
- Options for Math
- HTML 输出选项
- Options for Single HTML output
- Options for HTML help output
- Options for Apple Help output
- Options for epub output
- Options for LaTeX output
- Options for text output
- Options for manual page output
- Options for Texinfo output
- Options for QtHelp output
- Options for the linkcheck builder
- Options for the XML builder
- Options for the C domain
- Options for the C++ domain
- Options for the Python domain
- 构建器
- 插件
- HTML 主题化
- 国际化
- Setuptools integration
- Sphinx Web 支持