使用NumPyDoc样式的Napoleon Sphinx扩展的类方法列表

Question

我使用NumPyDoc风格的文档字符串来记录Python包。我想从'numpydoc' Sphinx扩展转换为Napoleon，因为我发现它以更紧凑和可读的方式格式化文档字符串。但是，它没有列出文档顶部的类的方法，我发现numpydoc的一个非常有价值的特性。有人知道如何在拿破仑手动启用它吗？

Answer 1

我是拿破仑/狮身人面像的新手，但我认为答案可能在于斯芬克斯，而不是拿破仑。

如果您在conf.py中启用了autodoc，例如

extensions = ['sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.coverage']

然后添加到index.rst（比如说）：

.. autoclass:: module_name.class_name
    :members:
    :undoc-members:

其中module_name包含相关类，然后class_name将在文档中及其所有方法中，即使它们当前没有文档字符串。