发布于 2015-09-16 15:49:57 | 254 次阅读 | 评论: 0 | 来源: 网络整理
该文档是Sphinx建立文档的参考. Sphinx 将 reStructuredText 源文件集转换为丰富的输出格式，并自动产生参考文献、索引等. 简言之，如果你有一个包含reST-格式的文档的目录（包含文档的所有文件或子目录）, Sphinx 会生成组织合理的HTML文件（在另一个目录里），使得浏览及导航功能使用非常方便. 通用一份源文件，你可以生成LaTeX 文件，然后编译成 PDF 版本的文档, 也可以直接使用 rst2pdf 生成PDF 文件.
重点讨论的是手写文档而不是自动生成的API文档. 但是我们对于两种都支持的很好，甚至支持两种内容混合的文档, 假如你需要纯净的API文档，查看 Epydoc, 它可以解析 reST.
这一节搜集了一些有用的提示，帮助我们从其他的文档系统迁移到reStructuredText/Sphinx.
Sphinx 运行前需要安装 Python 2.4 或者 Python 3.1 , 以及 docutils 和 Jinja2 库. Sphinx 必须工作在 0.7 版本及一些 SVN 快照(不能损坏). 如果需要源码支持高亮显示，则必须安装 Pygments 库.
如果使用 Python 2.4 ，还需要 uuid.
更深入的话题,请参考 Sphinx初尝 .