Sphinx¶

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

📝 富文本格式化

在 reStructuredText 或 MyST Markdown 中编写,以创建高度结构化的技术文档,包括表格、高亮代码块、数学符号等.

🔗 强大的交叉引用

在你的项目中创建交叉引用 ,甚至可以跨不同的项目 .包括对章节、图表、表格、引用、词汇表、代码对象等的引用.

📚 多功能的文档格式

生成适合您受众的首选格式的文档,包括 HTML、LaTeX（用于 PDF）、ePub、Texinfo、以及更多.

🎨 广泛的主题支持

创建视觉上吸引人的文档,提供多种内置和第三方 HTML 主题,并能够自定义或创建新主题.

🔌 完全可扩展

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

🛠️ 自动 API 文档

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

🌍 国际化 (i18n)

添加文档翻译多语言以接触全球受众.

🌟 活跃的社区和支持

受益于一个活跃的社区 ,拥有众多资源、教程、论坛和示例.

如由以下使用:

Python¶

Linux 内核¶

Project Jupyter¶

请参见下方以了解如何导航Sphinx的文档.

参见

Sphinx 文档目录有该站点页面的完整列表.

开始¶

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

这些章节涵盖了在使用和扩展Sphinx以满足各种需求时的各种主题.它们是使用Sphinx在许多上下文中的全面指南,并假设对Sphinx有更多的了解.如果你是Sphinx的新手,我们建议从开始开始.

Sphinx 是社区支持的,并欢迎任何人的贡献.下面的章节将帮助你开始加入 Sphinx 社区以及做出贡献.

如果您想为项目做出贡献,请参阅 Sphinx 贡献者指南.

社区

参考文档在本质上更完整且程序化,它是可以快速参考的信息集合.如果你需要用例驱动的文档,请参见开始或用户指南.