安装
使用pip进行安装:
pip install sphinx
初始化
进入你代码所在的目录,输入:
sphinx-quickstart
下图:PRD是代码所在目录,生成的文档保存目录设成doc
下图:设置项目名称与作者,项目名称之后会作为标题显示在文档首页
下图:基本一路默认
下图:到此,生成doc文件夹
配置修改
进入此文件夹找到conf.py文件,打开编辑,将下面几行代码(第19-21行)取消注释:
并修改代码为:
生成 rst
到代码目录,执行以下命令,会生成对应 python 文件名的 rst 文件
生成 html
进入doc文件夹,执行make指令,生成html文档页