一款无需构建过程、可将 Markdown 文件直接转为文档网站的工具。
3.2万5784JavaScriptMIT更新于 昨天
sphinx-doc/sphinx
基于 reStructuredText 的 Python 文档生成工具，可输出 HTML、PDF、EPUB 等多种格式。
- Star
- 8,072
- Fork
- 2,610
- 未关闭 Issue
- 1,453
- 最近提交
- 7小时前
这是什么？
Sphinx 是一款文档生成工具，可将 reStructuredText 源文件转换为结构清晰的文档，支持输出 HTML、PDF、纯文本、EPUB、TeX 和 manual page 等格式。它基于 Docutils 完成解析与转换。
它的重点在于交叉引用和文档结构管理。函数、类、术语表条目等内容可以进行语义化链接，文档按树形组织，并自动生成与同级、父级、子级文档之间的链接。此外还会自动生成总索引和模块索引。
代码高亮由 Pygments 完成，HTML 输出使用 Jinja 2 模板引擎。通过扩展机制，它还能支持函数自动文档、Jupyter Notebook，以及 Python、C、C++、JavaScript 和数学公式等语言领域。
核心功能
- 01支持输出 HTML、PDF、纯文本、EPUB、TeX 和 manual page
- 02为函数、类、术语表等提供语义化交叉引用
- 03文档按树形结构组织，自动生成相关页面之间的链接
- 04自动生成总索引和模块索引
- 05使用 Pygments 进行代码高亮，并通过 Jinja 2 模板渲染 HTML
- 06通过扩展支持 Python、C、C++、JavaScript 等语言及更多功能
适用场景
- 为 Python 库发布 API 参考文档
- 从同一份源文件生成 PDF 和 HTML 格式的技术手册
- 维护带交叉引用的项目文档
快速上手
- 1
使用 pip 从 PyPI 安装 Sphinx
pip install -U sphinx
使用前须知
- README 未明确给出许可证名称；元数据显示为 NOASSERTION，但徽章标注为 BSD 2-Clause。
标签
常见问题
- sphinx 是什么？
- 基于 reStructuredText 的 Python 文档生成工具，可输出 HTML、PDF、EPUB 等多种格式。 Sphinx 是一款文档生成工具，可将 reStructuredText 源文件转换为结构清晰的文档，支持输出 HTML、PDF、纯文本、EPUB、TeX 和 manual page 等格式。它基于 Docutils 完成解析与转换。
- sphinx 可以免费使用吗？用的什么许可证？
- sphinx 以 Other 许可证开源。用于商业产品前，请先确认许可证条款。
- sphinx 还在维护吗？
- 活跃维护中。sphinx 最近一次提交是在 2026年10月22日。
- sphinx 适合用来做什么？
- 为 Python 库发布 API 参考文档 从同一份源文件生成 PDF 和 HTML 格式的技术手册 维护带交叉引用的项目文档
- sphinx 怎么安装和运行？
- 使用 pip 从 PyPI 安装 Sphinx: pip install -U sphinx
- 在哪里获取 sphinx？
- 源代码和安装说明在 GitHub 上：https://github.com/sphinx-doc/sphinx
概要由 AI 根据项目 README 生成；GitHub 数据每日更新。
相关项目
一个将多种开发者 API 文档整合到一起、支持即时搜索和离线使用的网页文档浏览器。
4万2655RubyMPL-2.0更新于 昨天
基于 Vite 和 Vue 构建的静态站点生成器，用于从 Markdown 创建文档和内容网站。
1.8万2752TypeScriptMIT更新于 前天
基于 React.js 构建文档网站的框架，支持 Next.js、Astro 及多种 Vite 生态的 React 框架。
1.3万745TypeScriptMIT更新于 前天
一个以单一二进制文件分发的静态站点生成器，内置 Markdown、Sass、图片处理和搜索功能。
1.8万1195RustEUPL-1.2更新于 3天前
从数据库结构自动生成可交互、易读的 ER 图，支持网址直接生成或使用 CLI。
5145241TypeScriptApache-2.0更新于 6天前