本文介绍了如何使用零配置的Sphinx生成Python文档？的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！
问题描述
我们不想同时维护文档和源代码，而Sphinx似乎需要大量的设置和配置。(我们只需要一些基本的API文档。)在一个python项目中，难道没有一个命令可以只迭代所有的包、模块、类和函数来生成以HTML格式生成的文档吗？
sphinx-apidoc将内容拆分到一个目录中，在修改conf.py使我们的包位于sys.path中之后，我们可以运行"make html"，但它只列出包和模块，而不记录任何类或函数。
谢谢！
推荐答案
sphinx-apidoc工具将自动为您的模块生成存根，这可能是您需要的。
说明
确保在Sphinx配置期间启用
autodoc模块。extensions = ['sphinx.ext.autodoc']在Sphinx的
conf.py中应该可以做到这一点。确保
conf.py相应地调整sys.path(请参阅文件中第16-19行的注释)。sys.path.insert(0, os.path.abspath('/my/source/lives/here'))运行
sphinx-apidoc以生成骨架。sphinx-apidoc -o /my/docs/live/here /my/source/lives/here重新生成文档。如果一切正常，您不应该收到以下警告：
mymode.rst：4：警告：AutoDoc无法导入/查找模块‘myModule’
您的模块RST现在应该已填充。
这篇关于如何使用零配置的Sphinx生成Python文档？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除！