Sphinx

sphinx-doc.org官网已核对又名 Sphinx Documentation、sphinx-doc

开源的文档生成工具,用 reStructuredText 或 MyST Markdown 写源文件,可编译成 HTML、PDF、ePub,并能从 docstring 自动生成 API 文档,适合维护开源项目的开发者跟着代码改手册。

打开官网替代品 3 个 本站 11 月 22 日 实测可以打开
最近 5 次实测

4 次可以打开平均 3.7 秒11 月 19 日 起国内不可直接访问

本站从国内机房定期实测。竖条由远及近:绿 = 可以打开,橙 = 国内不可直接访问,灰 = 打不开。
sphinx-doc.orgSphinx 首页截图

sphinx-doc.org 首页 · 本站实拍 · 点开看大图

Sphinx 是一个开源的文档生成工具,最初为 Python 文档而做,现在被大量软件项目用来写技术手册。你按它的格式写源文件,它把内容编译成 HTML 网站、LaTeX(再转 PDF)、ePub、Texinfo 等成品,同一份源文件可以出多种格式。

写作时用 reStructuredText 或 MyST Markdown,表格、带高亮的代码块、数学公式都能直接写进去。它比较特别的地方是交叉引用:章节、图、表、术语表、代码对象之间可以互相链接,跨项目也能引。

主要功能

  • 自动 API 文档:为 Python、C++ 等语言生成接口文档,可以从 docstring 自动抽取,代码改了文档跟着更新。
  • 主题与扩展:自带多套 HTML 主题,也能装第三方主题;通过扩展机制加画图、测代码等功能,内置和第三方扩展都不少。
  • 多语言:支持把文档翻译成多种语言,面向不同语言的读者。
  • 安装方式:PyPI、Conda、系统包管理器、Docker 或源码都能装。

适合谁

写软件文档的开发者、维护开源项目文档的人,以及需要把同一套内容发布成网页和 PDF 的技术写作团队。官方页面列出的使用者包括 Python、Linux Kernel 和 Project Jupyter。

费用与限制

工具本身开源免费,但要自己在本地装环境、跑构建命令,不是打开网页就能写的在线编辑器。文档站是英文的,上手需要先熟悉 reStructuredText 或 Markdown 的写法与配置项。当前版本为 9.3.0(开发中),9.2.0 于 2026 年 10 月 20 日发布。

常见问题

Sphinx 收费吗?
Sphinx 免费使用。

替代品全部 3 个,带对比表 →

替代品 3打开官网