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

Question

我正在使用 NumPyDoc 样式的文档字符串来记录 Python 包。我想从'numpydoc'转狮身人面像扩展到 Napoleon ，因为我发现它以更紧凑和可读的方式格式化文档字符串。但是，它没有在文档顶部列出类的方法，我发现这是 numpydoc 的一个非常有值(value)的特性。有谁知道如何在拿破仑中手动打开它？

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将与它的所有方法一起出现在文档中，即使它们当前没有文档字符串。