一、什么是Sphinx？

狮身人面像(Sphinx)是一个让编写智能/漂亮文档变得容易的工具，由格奥尔格布兰德(Georg Brandl)在BSD许可下创建。

Sphinx一直支持新Python文档的生成，成为Python项目的文档工具，对C/C项目也有很好的支持；此外，还将特别支持其他开发语言。当然，这个网站是使用Sphnix从新构造的文本构建的！

Sphnix还在开发中。以下特性运行良好，并在Python官方文档中“具体化”。

丰富的输出格式有： HTML(包括M$ help)、LaTeX (PDF输出)、手动页面(man)和纯文本

完整的交叉引用：语义标签，以及函数、类、引用、术语和类似片段消息的自动链接

清晰的层次结构：轻松定义文档树，并自动链接对等/父/子文章

漂亮自动索引：可以自动生成漂亮的模块索引

语法突出显示：自动生成基于Pygments的语法突出显示

开放扩展：支持代码块的自动测试，自动包含Python的模块自述文档等

狮身人面像使用新的结构化文本作为标记语言，因此它直接享受了Docutils为结构化文本提供的许多工具和功能！

二、安装Sphinx

本次测试的安装环境：debian5

1）安装python

python:http://www.python.org/download/

2）安装setuptools

Setuptools下载地址

Windows安装方法：

直接下载python版本对应的setuptools exe安装文件，安装在http://pypi . python . org/packages/2.7/s/setuptools/setuptools-0.6 c 11 . win32-py 2.7 . exe # MD5=57e 1 e 64 F6 b 7 C1 D2 edd fc 9746 bbaf 20

苹果OS X，Linux安装方法：

下载相应版本的setuptools文件，我的python版本是2.6.6。

wget http://pypi . python . org/packages/2.6/s/setup tools/setup tools-0.6 c11-py 2.6 . egg # MD5=BFA 92100 BD 772 D5 a 213 eedd 356d 64086

安装setuptools

sh setuptools-0.6c11-py2.6.egg

现在可以使用easy_install命令了。

3）安装Sphinx

易于安装-U狮身人面像

安装完成，尽情享受吧！