欢迎

Sphinx使您可以轻松创建智能而美观的文档。

以下是Sphinx的一些主要功能:

  • Output formats: 超文本标记语言(包括Windows超文本标记语言帮助)、LaTeX(可打印PDF版本)、ePub、纹理信息、手册页、纯文本

  • Extensive cross-references: 功能、类别、引用、术语表术语和类似信息的语义标记和自动链接

  • Hierarchical structure: 轻松定义文档树,并自动链接到兄弟姐妹、父代和子代

  • Automatic indices: 通用索引以及特定语言模块的索引

  • Code handling: 自动突出显示使用 Pygments 荧光笔

  • Extensions: 自动测试代码片段,通过以下方式包含来自Python模块(API文档)的文档字符串 built-in extensions ,和更多功能,通过 third-party extensions

  • Themes: 通过以下方式修改输出的外观 creating themes ,并重复使用许多 third-party themes

  • Contributed extensions: 数十个扩展 contributed by users ;它们中的大多数都可以从PyPI安装。

Sphinx使用 reStructuredText 默认的标记语言,并且可以阅读 MyST markdown 通过第三方分机。这两个工具都功能强大、使用简单,并且具有用于复杂文档和发布工作流的功能。它们都建立在 Docutils 来解析和编写文档。

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

参见

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

开始

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

用户指南

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

社区指南

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

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

参考指南

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