Sphinx Documentation Generator是用python编写并基于jinja模板的Web软件。
直接HTML输出，使其变得超快并能与所有浏览器一起使用。
使用reStructuredText（rst）标记为任何项目创建任何文档。
Sphinx利用其丰富的功能使文档Project更加容易。
在本教程中，我们将逐步介绍安装和配置过程。

步骤1（安装必需的模块）

在Ubuntu及其衍生产品上
首先更新存储库，以便更新软件包对安装有用

# apt-get update

因此，安装所需的软件包

# apt-get install python-pip python-dev apache2

在CentOS及其衍生版本上

在安装和启用EPEL信息库以获取更好的软件包支持时。

# yum install epel-release

之后，对于安装必需的软件包来说是必不可少的。

# yum install python-pip python-devel httpd

步骤2（使用Python包管理器安装Sphinx）

这是升级Python包管理器的最佳方法

# pip install --upgrade pip

之后，安装Setuptools

# easy_install -U setuptools

最后，使用基于pip的python软件包安装程序安装Sphinx。

# pip install sphinx

步骤3（选择安装Sphinx的路径）

将目录更改为我们将要安装sphinx软件的目录。

# cd /var/www/html/

运行Sphinx安装脚本
运行自动狮身人面像安装脚本。

# sphinx-quickstart

步骤4（创建静态HTML文件）

# make html

创建索引文件
重命名项目HTML文件以对HTML进行索引以使其与Apache Web服务器一起正常工作

# cp -rv /var/www/html/_build/html/yourproject.html /var/www/html/_build/html/index.html

步骤5（将静态文件路径添加到Apache虚拟配置文件）

在Ubuntu及其衍生产品上

# vi /etc/apache2/sites-available/000-default.conf

在CentOS及其衍生版本上

# vi /etc/httpd/conf.d/welcome.conf

运行此命令后，添加给定的行

<VirtualHost *:80>
ServerAdmin webmaster@localhost
DocumentRoot /var/www/html/_build/html/
</VirtualHost>

完成所有操作后，重新启动Apache Services
在Ubuntu及其衍生产品上

# sudo systemctl restart apache2

在CentOS及其衍生版本上

# sudo systemctl restart httpd

步骤6（在浏览器中检查Sphinx）

现在，Sphinx python文档生成器已在服务器IP上启用。

最后，将数据添加到源文件中。

# vi /var/www/html/_build/html/_sources/yourproject.txt

对于种类信息，它使用reStructuredText进行纯文本标记语法。

有关更多信息和参考，请使用Sphinx python Doc官方。

现在我们已在CentOS和Ubuntu上安装了Sphinx。