Sphinx将python代码注释生成文档


安装

使用pip进行安装:

pip install sphinx

初始化

进入你代码所在的目录,输入:

sphinx-quickstart

下图:PRD是代码所在目录,生成的文档保存目录设成doc 
这里写图片描述

下图:设置项目名称与作者,项目名称之后会作为标题显示在文档首页 
这里写图片描述

下图:基本一路默认 
这里写图片描述

下图:到此,生成doc文件夹 
这里写图片描述

配置修改

进入此文件夹找到conf.py文件,打开编辑,将下面几行代码(第19-21行)取消注释:

并修改代码为:

生成 rst

到代码目录,执行以下命令,会生成对应 python 文件名的 rst 文件

这里写图片描述

生成 html

进入doc文件夹,执行make指令,生成html文档页 
这里写图片描述

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM