如何解决获取自动摘要以生成平面表示
from foo.bar.baz import Quux,Quuux
__all__ = ['Quux','Quuux']
我想按如下方式记录 api:
Baz
===
.. currentmodule:: foo.baz
.. autosummary::
:toctree: generated/
:nosignatures:
Quux
Quuux
这为我提供了一个包含 Quux
和 Quuux
的自动汇总表,以及指向包含其完整文档的页面的链接。但是,它需要我明确列出 Quux
和 Quuux
,因此每当我添加一个类时,我都必须手动将其添加到文档中。
相反,我更愿意做这样的事情,让它根据 __all__
自动生成一个表,以获得与上面完全相同的输出:
Baz
===
.. currentmodule:: foo
.. autosummary::
:toctree: generated/
:nosignatures:
baz
但这不起作用,它会生成一个包含单个条目的表格,即模块 baz
,然后指向一个包含其所有内容和汇总表的页面。
有没有办法做到这一点?如果相关,我将使用 numpydoc
。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。