Sphinx 文档工具

• 授权协议: BSD
• 开发语言: Python
• 操作系统: 跨平台
• 软件首页: http://www.sphinx-doc.org/
• 软件文档: http://www.sphinx-doc.org/en/stable/contents.html
• 官方下载: http://www.sphinx-doc.org/en/stable/install.html

软件介绍

Sphinx简单来说，是一个文档生成工具，用于把reStructuredText 格式的源文件生成诸如HTML, PDF, LaTex一类的格式。编辑者无须亲自处理文本的格式, 程序会自动根据源文件里的设置产生格式, 以及自动生成章节链接等工作。

和 DocBook一样，Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧，大家一定都曾有过上学时用Word痛苦地修改论文 的经验（没办法，在中国LaTex太小众），其中Word里面千奇百怪的可见或不可见的格式符、控制符一定玩弄了大家很久。而类似DocBook或 reStructuredText 一类的格式则完全采用文本文件来记录文字格式，各种格式控制字符完全可见，不会出现如Word里某个隐藏在段落末尾的莫名控制符导致文章之后的某些部分完 全乱掉，而完全找不到这个控制符的情况了。同时，完全采用纯文本文件进行记录，使得使用版本控制软件对编辑工作进行全程追踪和记录成为了可能。而最终通过 文本的源文件生成具有格式和样式的文本则完全是程序所进行的工作，避免了一切出错的可能。

使用Sphinx的项目有很多，著名的包括 Python , Django 的文档，全部是使用Sphinx 生成的。

本文地址：https://codercto.com/soft/d/20956.html