Python:Sphinx:如何在sphinx文档中自动包含所有类,方法和函数？

Question

可能重复:
Sphinx - 结合自动模块和autoclass

我尝试使用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>