在Sphinx doc生成器中,我可以将整个包(recursivly)添加到索引吗？

Question

我想为我的包生成文档.项目中的每个文件都包含大量文档.有没有办法快速将我的整个项目添加到documetation索引？

我想尽可能少地为整个项目生成一些文档.我首先将以下内容添加到index.rst:

.. automodule:: mymodulename
    :members:

所有似乎已经完成的是文件中的文档元素__init__.py(只是文档字符串) - 有什么方法可以让它记录其他所有内容吗？我希望绝对添加我的包中定义的所有内容,并将包中的每个类,常量,函数(等)添加到适当的索引中.

可以这样做吗？

Answer 1

你可以用sphinx-apidoc.
从官方文档:sphinx-apidoc是一个自动生成Sphinx源的工具,使用autodoc扩展,以其他自动API文档工具的方式记录整个包.

一个用法示例可能是(来自您的项目根目录):

$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0'

doc将创建一个目录,其中包含所有内容.
您还可以调整文档的设置,编辑自动生成的conf.py文件.