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

Python 如何在sphinx文档中自动包含所有类、方法和函数?,python,python-sphinx,autodoc,Python,Python Sphinx,Autodoc,我尝试使用sphinx及其autodoc插件为包含数千个类的项目创建html文档。sphinx apidoc创建了出色的rst文件,但缺少自动类和自动方法的自动创建 sphinx中是否有方法/命令/实用程序自动将所有变量、函数、类和装饰器包含在文档中? 一个rst文件的一些示例代码: tagger Package ================= :mod:`tagger` Package ------------------------ .. automodule:: project.ta

我尝试使用sphinx及其autodoc插件为包含数千个类的项目创建html文档。sphinx apidoc创建了出色的rst文件,但缺少自动类和自动方法的自动创建

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

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

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

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


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

有一个Sphinx扩展,它将在这方面帮助您

如果要包含该类,则必须编写:

.. autoclass:: <ClassName>
。。自动类::
类似地,对于方法:

.. automethod:: <MethodName>
。。自动方法::

您已经检查了吗?autodoc扩展添加到conf.py:extensions=['sphinx.ext.autodoc','sphinx.ext.viewcode']sphinx检测所有模块,但它没有列出类和方法。根据上述autodoc扩展,没有docstring的成员将被忽略,除非您给undoc成员标记选项“我使用autodoc”。这意味着我必须添加..autoclass一千次以上,或者创建一个脚本。没有自动检测吗?您可以使用
automodule
如果您想自动记录成员,有一个成员选项。请检查链接。autodoc扩展中有很多选项。对我来说,添加:members:和:undoc members:成功了