Sphinx¶

轻松创建智能且美观的文档

📝 富文本格式

使用 reStructuredText 或 MyST Markdown 编写，创建高度结构化的技术文档，包括表格、代码块高亮、数学符号等等。

🔗 强大的交叉引用

在您的项目中创建交叉引用，甚至跨不同项目。包含对章节、图形、表格、引用、词汇表、代码对象等的引用。

📚 多功能文档格式

以受众喜爱的格式生成文档，包括 HTML、LaTeX（用于 PDF）、ePub、Texinfo 等等。

🎨 广泛的主题支持

创建视觉上吸引人的文档，可以选择各种内置和第三方 HTML 主题，并能够自定义或创建新的主题。

🔌 完全可扩展

通过强大的扩展机制添加自定义功能，并提供大量内置和第三方扩展，用于创建图表、测试代码等任务。

🛠️ 自动 API 文档

为 Python、C++ 和其他软件领域生成 API 文档，可以手动生成或从文档字符串自动生成，确保您的代码文档在付出最少努力的情况下与代码保持同步。

🌍 国际化 (i18n)

添加文档翻译到多种语言，以覆盖全球受众。

🌟 活跃的社区和支持

受益于一个活跃的社区，拥有丰富的资源、教程、论坛和示例。

被以下项目使用

Python¶

Linux 内核¶

Project Jupyter¶

请参见以下内容，了解如何浏览 Sphinx 文档。

另请参见

Sphinx 文档目录包含此站点所有页面的完整列表。

入门¶

这些部分介绍了 Sphinx 入门的基础知识，包括从头开始创建和构建自己的文档。

这些部分涵盖了在各种用例中使用和扩展 Sphinx 的各种主题。它们是使用 Sphinx 的综合指南，并假设您对 Sphinx 有一定的了解。如果您是 Sphinx 新手，建议您从入门开始。

Sphinx 受社区支持，欢迎任何人的贡献。以下部分将帮助您开始加入 Sphinx 社区并做出贡献。

如果您想为该项目做出贡献，请参阅 Sphinx 贡献者指南。

社区

参考文档更完整且具有程序化特性，它是可快速参考的信息集合。如果您需要用例驱动的文档，请参阅入门或用户指南。