Sphinx¶

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

📝Rich text

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

🔗强大的交叉引用

创建 cross-references 在您的项目中，甚至在 different projects .包括对节、图、表、引文、词汇表、代码对象等的引用。

多功能文档格式

以受众首选的格式生成文档，包括HTML、LaTeX（用于PDF）、ePub、Texinfo、 and more .

🎨广泛的主题支持

创建视觉吸引人的文档，可选择广泛 built-in 和 third-party HTML主题和自定义或 create new themes .

完全可扩展

通过健壮添加自定义功能 extension mechanisms 与众多 built-in 和 third-party 可用于创建图表、测试代码等任务的扩展。

🛠️Automatic API Documentation

生成Python、C++和其他API文档 software domains ，手动或 automatically from docstrings ，确保您的代码文档以最少的努力保持最新。

🌍国际化（i18 n）

添加文档 translations 多种语言，以达到全球观众。

TransActive社区和支持

受益于 active community ，包含大量资源、教程、论坛和示例。

使用者：

Python¶

Linux内核¶

Jupyter项目¶

有关如何浏览Sphinx的文档，请参阅下面的内容。

参见

这个 Sphinx documentation Table of Contents 有此站点页面的完整列表。

开始¶

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

备注

构建时间： 2025 年 05 月 29 日

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

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

请参阅 Sphinx contributors' guide 如果你愿意为这个项目做贡献的话。

社区

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