使用Sphinx生成本地的Python帮助文档

时间:2021-04-25 17:59:57

第一步:安装Sphinx

首先我们需要安装Sphinx,如果已经安装了Anaconda,那么只需要使用如下命令即可安装,关于其中的参数 -c anaconda,可以在链接[1]中查看:

conda install -c anaconda sphinx

也可以使用pip安装:

pip install sphinx

安装成功后,新建一个空文件夹,从命令行进入此文件夹,输入如下命令启动sphinx:

sphinx-quickstart

之后根据提示一步步操作(碰到yes or no时都选择yes)。

第二步:将帮助文档转换为HTML

从python的帮助文档地址下载帮助源文件,源文件都是.rst格式。

使用Sphinx生成本地的Python帮助文档

将这些文档放入第一步建立的文件夹下,覆盖其中的index.rst,然后在命令行运行:

make html

很快这些文档就转换成了我们需要的HTML文档,如下图所示:

使用Sphinx生成本地的Python帮助文档

这里使用的是默认的HTML主题:'alabaster',也可以自己修改主题样式,参考链接[4]。

参考链接:

[1] https://docs.conda.io/projects/conda/en/latest/commands/install.html#Positional%20Arguments

[2] http://www.sphinx-doc.org/en/master/usage/quickstart.html

[3] https://github.com/python/cpython/tree/master/Doc/tutorial

[4] https://www.sphinx-doc.org/en/master/usage/theming.html#builtin-themes