Sphinx¶

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

📝 富文本格式

使用 reStructuredText 或 MyST Markdown 进行创作，以创建高度结构化的技术文档，包括表格、突出显示的代码块、数学符号等等。

🔗 强大的交叉引用

在你的项目内创建交叉引用，甚至跨越不同的项目。包括对章节、图表、表格、引用、词汇表、代码对象等的引用。

📚 多功能的文档格式

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

🎨 广泛的主题支持

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

🔌 完全可扩展

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

🛠️ 自动 API 文档

为 Python、C++ 和其他软件领域生成 API 文档，手动或从文档字符串自动生成，确保你的代码文档保持最新，且只需最少的努力。

🌍 国际化 (i18n)

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

🌟 活跃的社区和支持

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

使用者包括

Python¶

Linux Kernel¶

Project Jupyter¶

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

另请参阅

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

开始使用¶

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

这些章节涵盖了使用和扩展 Sphinx 以适应各种用例的各种主题。它们是关于在多种情况下使用 Sphinx 的综合指南，并假设你对 Sphinx 有更多的了解。如果你是 Sphinx 的新手，我们建议从开始使用开始。

Sphinx 由社区支持，欢迎任何人的贡献。以下章节应帮助你开始加入 Sphinx 社区以及做出贡献。

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

社区

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

参考