Sphinx

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

📝 富文本格式

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

🔗 强大的交叉引用

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

📚 多功能的文档格式

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

🎨 广泛的主题支持

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

🔌 完全可扩展

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

🛠️ 自动 API 文档

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

🌍 国际化 (i18n)

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

🌟 活跃的社区和支持

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


使用方

Python Logo

Python

Linux Logo

Linux 内核

Jupyter Logo

Project Jupyter


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

另请参阅

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

入门

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

用户指南

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

社区指南

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

如果你想为项目做贡献,请参阅《Sphinx 贡献者指南》。

参考指南

参考文档在本质上更完整且更偏程序化,它是可以快速参考的信息集合。如果你想要用例驱动的文档,请参阅 入门用户指南