根据Github源码的docs文件夹创建项目的html官方离线文档(Windows,Python项目)

根据Github源码的docs文件夹创建项目的html官方离线文档(Windows,Python项目)

前几天,我想使用py2neo 这个python包。因为有段时间没有使用了,很多api已经忘记。于是我去找官方文档看看,但是官方文档的网站死活打不开。于是我看github的源码是有docs文件夹,只不过还没有转html而已。于是我c参考 pymongo官方文档的构建过程 成功构建了py2neo 2020.1.0版本 的文档。

pymongo官方文档的构建过程图

image-20220227131722682

虽然pymongo官方文档的构建过程 有很多步,但我们不一定要每一步都执行。

我执行的步骤

下面命令要求安装有python解析器。

【1】cmd进入 源码的docs文件夹。执行下面命令

pip install -r requirements.txt

image-20220227131937539

image-20220227132106101

【2】继续执行下面命令

cat conf.py

image-20220227132146802

【3】最后执行下面命令生成文档html

python -m sphinx -T -E -W --keep-going -b html -d _build/doctrees -D language=en . _build/html

上面的参数要注意language,因为我py2neo 只要英文文档,所以是en。具体的自行把握。

最后的_build/html 是html的生成地址

【4】 打开index.html 即可打开文档首页。

image-20220227132546036

开心一刻
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/qq_38463737/article/details/123163135