python-sphinx - 获取自动摘要以生成平面表示

Question

如果我有一个文件foo.baz.py：

from foo.bar.baz import Quux, Quuux

__all__ = ['Quux', 'Quuux']

我想按如下方式记录 api：

Baz
===

.. currentmodule:: foo.baz

.. autosummary::
   :toctree: generated/
   :nosignatures:

   Quux
   Quuux

Quux这给了我一个带有和的自动汇总表Quuux，以及指向包含其完整文档的页面的链接。但是，它需要我明确列出Quuxand Quuux，所以每当我添加一个类时，我都必须手动将它添加到文档中。

相反，我宁愿做这样的事情，并让它自动生成一个基于 的表__all__，以获得与上面完全相同的输出：

Baz
===

.. currentmodule:: foo

.. autosummary::
   :toctree: generated/
   :nosignatures:

   baz

但这不起作用，它会生成一个带有单个条目的表，模块baz，通向一个包含所有内容的页面以及一个汇总表。

有没有办法做到这一点？如果它是相关的，我正在使用numpydoc.

标签： python-sphinxnumpydoc