脚本宝典收集整理的这篇文章主要介绍了

python项目用sphinx文档生成

脚本宝典小编觉得挺不错的,现在分享给大家,也给大家做个参考,希望能帮助你少写一行代码,多一份安全和惬意。

python项目用sphinx文档生成

使用内置命令

sphinx-apidoc -o doc waterfal
得到 rst 文件

localhost:doc timger$ ls
modules.rst             waterfall.glblog.rst    waterfall.master.rst    waterfall.rst
waterfall.excepts.rst   waterfall.lib.rst       waterfall.p2plog.rst    waterfall.slowspeed.rst

自己编辑 conf.py
或者加上 -F

localhost:waterfall timger$ sphinx-apidoc -F -o doc waterfall
Creating file doc/waterfall.rst.
Creating file doc/waterfall.excepts.rst.
Creating file doc/waterfall.glblog.rst.
Creating file doc/waterfall.lib.rst.
Creating file doc/waterfall.master.rst.
Creating file doc/waterfall.p2plog.rst.
Creating file doc/waterfall.slowspeed.rst.
Creating file doc/conf.py.
Creating file doc/index.rst.
Creating file doc/Makefile.
Creating file doc/make.bat.

然后 直接 make html

注意需要在 conf.py 里面加入项目路径让他能够 import

如果路径很深 需要 -d 10 后面参数根据情况

总结

以上是脚本宝典为你收集整理的

python项目用sphinx文档生成

全部内容,希望文章能够帮你解决

python项目用sphinx文档生成

所遇到的程序开发问题,欢迎加入QQ群277859234一起讨论学习。如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典网站推荐给程序员好友。 本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。

80%的人都看过