Sphinx¶

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

📝 丰富的文本格式

使用reStructuredText或MyST Markdown编写高度结构化的技术文档，含表格、高亮代码块、数学公式等。

🔗 强大的交叉引用

在您的项目内创建交叉引用，甚至跨项目引用。可以引用章节、图形、表格、引用、术语表、代码对象等。

📚 多样化的文档格式

以受众偏好的格式生成文档，包括 HTML、LaTeX(用于PDF)、ePub、Texinfo以及更多其它格式的构建器。

🎨 广泛的主题(html主题)支持

创建吸引眼球的文档，提供多种内置和第三方 HTML 主题。并且可以自定义或创建新主题。

🔌 完全可扩展

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

🛠️ 自动生成 API 文档

为Python、C++和其他软件域手动或从docstrings自动生成生成API文档，轻松让您的代码文档保持最新。

🌍 国际化（i18n）

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

🌟 活跃的社区和支持

得益于活跃的社区，享无数资源、教程、论坛和示例。

采用 Sphinx 的项目：

Python¶

Linux 内核¶

Jupyter 项目¶

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

参见

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

开始使用¶

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

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

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

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

社区

参考文档更完整且具有程序性，它是可以快速引用的信息集合。如果您想要基于用例的文档，请参阅开始使用或用户指南。

参考