Sphinx (文档生成器)
Sphinx是Python社区编写和使用的文档生成器。它是用Python编写的，也可以在其他环境中使用。
 | |
| 開發者 | Georg Brandl |
|---|---|
| 首次发布 | 2008年3月21日 |
| 当前版本 | 1.8.1[1]（2018年9月22日） |
| 预览版本 | 2.0.0 |
| 源代码库 | |
| 编程语言 | Python |
| 操作系统 | 跨平台 |
| 类型 | 文档生成器 |
| 许可协议 | BSD许可证 |
| 网站 | sphinx-doc |
目的和功能
Sphinx将reStructuredText文件转换为HTML网站和其他格式，包括PDF、EPUB、Texinfo和man。
reStructuredText是可扩展的，Sphinx通过许多扩展来利用其可扩展性 — 用于从源代码自动生成文档、编写数学符号或突出显示源代码等。
历史和使用
2008年3月21日，发布了第一个公共版本0.1.61611。[2]它是为Python项目的文档开发的，也已得到了广泛的应用。[3]
自2008年Sphinx被引入以来，已经被许多其他重要的Python项目采用，包括Bazaar、SQLAlchemy、MayaVi、SageMath、SciPy、Django和Pylons。它还用于Blender用户手册[4]和Python API文档。[5]
2010年，Eric Holscher宣布[6]创建Read the Docs项目，作为使软件文档维护更容易的努力的一部分。Read the Docs可以在每次提交之后自动构建和上传Sphinx文档。
Linux内核
Linux内核的文档子系统在2016年发生了变化。从4.7开发周期开始，文档开始切换到使用Sphinx。[7]
- LCA2016 演讲：作为内核文档维护者的我学到了什么（YouTube上的What I've learned as the kernel docs maintainer）
- LCA2017 演讲：内核文档：现状及未来（YouTube上的Kernel documentation: what we have and where it's going）
另请参阅
参考文献
- ^ Changes in Sphinx. [2018-12-07]. （原始内容存档于2015-12-26）.
- ^ Sphinx is released! » And now for something completely Pythonic.... And now for something completely Pythonic... Georg Brandl. [2011-04-03]. （原始内容存档于2012-03-22）.
- ^ About these documents — Python v2.7.1 documentation. Python documentation. Python Software Foundation. [2011-04-03]. （原始内容存档于2012-10-25）.
- ^ Blender User Manual. Blender Wiki. Blender Foundation. [2018-12-07]. （原始内容存档于2016-08-26）.
- ^ Dev:2.5/Py/API/Generating API Reference - BlenderWiki!. Blender Foundation. Blender Foundation. [2018-12-07]. （原始内容存档于2013-01-26）.
- ^ Announcing Read The Docs. Python Software Foundation News. Eric Holscher. [2015-02-15]. （原始内容存档于2013-01-26）.
- ^ Kernel documentation update. LWN.net. 2016-11-02 [2018-12-07]. （原始内容存档于2018-11-23）.
外部链接
- Sphinx文档生成器项目网站（页面存档备份，存于互联网档案馆）
- Read the Docs（页面存档备份，存于互联网档案馆） 提供Sphinx支持的大型协作文档主机