如何将Sphinx的Autodoc扩展用于私有方法？

Question

我使用Sphinx来记录我的python项目。我已经启用了autodoc扩展，并且在我的文档中有以下内容。

.. autoclass:: ClassName
   :members:

问题是，它只记录类中的non-private methods。我该如何包含私有方法呢？

Answer 1

您可以将此添加到conf.py文件：

autodoc_default_flags = ['members', 'undoc-members', 'private-members', 'special-members', 'inherited-members', 'show-inheritance']