如何在零配置下使用Sphinx生成Python文档？
我们不想同时维护文档和源代码，因为源代码现在变化很快，但使用Sphinx似乎需要进行很多繁琐的设置和配置。（我们只需要一些基本的API文档。）难道就没有一个简单的命令可以在Python项目中运行，自动遍历所有的包、模块、类和函数，生成HTML格式的文档吗？
sphinx-apidoc会把东西放到一个目录里，之后我们修改conf.py文件，把我们的包添加到sys.path中，然后可以运行“make html”，但这样做只列出了包和模块，并没有记录任何类或函数。
谢谢！
1 个回答
19
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重新构建文档。如果一切顺利，你应该不会看到以下类型的警告：
mymodule.rst:4: WARNING: autodoc can't import/find module 'mymodule'
现在你的模块的RST文件应该已经填充好了。