Sphinx¶

轻松创建智能美观的文档

📝 丰富的文本格式

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

🔗 强大的交叉引用

在您的项目内部，甚至跨不同项目创建交叉引用。包括对章节、图、表、引用、术语表、代码对象等的引用。

📚 多样化的文档格式

以受众偏好的格式生成文档，包括 HTML、LaTeX (用于 PDF)、ePub、Texinfo 等。

🎨 广泛的主题支持

创建具有视觉吸引力的文档，有多种内置和第三方 HTML 主题可供选择，并能够自定义或创建新主题。

🔌 完全可扩展

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

🛠️ 自动 API 文档

为 Python、C++ 和其他软件领域生成 API 文档，手动或从 docstring 自动生成，确保您的代码文档以最小的精力保持最新。

🌍 国际化 (i18n)

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

🌟 活跃的社区和支持

受益于活跃的社区，拥有众多资源、教程、论坛和示例。

使用方

Python¶

Linux 内核¶

Project Jupyter¶

请参阅下方了解如何浏览 Sphinx 的文档。

另请参阅

Sphinx 文档目录包含本网站页面的完整列表。

开始¶

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

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

Sphinx 得到了社区的支持，并欢迎任何人的贡献。以下部分应有助于您开始加入 Sphinx 社区并做出贡献。

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

社区

参考文档本质上更完整和程序化，它是可以快速引用的信息集合。如果您需要用例驱动的文档，请参阅开始或用户指南。

参考