python - 如何在 sphinx 文档中自动包含所有类、方法和函数？

Question

我尝试使用 sphinx 和它的 autodoc 插件为包含数千个类的项目创建一个 html 文档。sphinx-apidoc创建了精彩的 rst 文件，但缺少自动创建autoclasses和automethods。

sphinx 中是否有一种方法/命令/实用程序可以在文档中自动包含所有变量、函数、类和装饰器？

一个 rst 文件的一些示例代码：

tagger Package
=================

:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
    :members:


:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
    :members:

Answer 1

有一个 Sphinx 扩展可以帮助您解决这个问题，称为autodoc。

如果要包含该课程，则必须编写：

.. autoclass:: <ClassName>

类似的方法：

.. automethod:: <MethodName>