获得“平坦” sphinx automodule 的成员输出

Question

我正在使用 Sphinx autodoc 扩展来记录模块，并且我希望在文档输出中获得模块成员的平面列表。

我尝试使用以下内容：

.. automodule:: modname
   :members:

但是，这有两个问题：

1. 它包括模块的文档字符串，我不想要在这里。

2. 每个条目的名称都以“modname.”为前缀，这是完全多余的（因为此页面专门用于记录此模块）

但是，我无法找到任何配置选项来让我有选择地禁用这两个方面，同时仍然获得所有模块成员的自动列表。

我当前的计划是仅使用 autofunction （等）并显式枚举要记录的成员，但我仍然想知道我是否错过了实现我最初想要的东西的简单方法。

更新：我至少找到了第二部分的解决方法：在conf.py中设置add_module_names=False。但这是一个全球环境，所以它并不能真正回答我最初的问题。

Answer 1

查看此类似问题的答案，我发现您可以使用autodoc-process-docstring 事件以删除来自模块的文档字符串将以下代码附加到您的 conf.py：

def skip_modules_docstring(app, what, name, obj, options, lines):
    if what == 'module':
        del lines[:]

def setup(app):
    app.connect('autodoc-process-docstring', skip_modules_docstring)

请注意，需要 del 语句，因为根据文档，对 lines 的修改code> 必须就地发生（如果你创建一个新对象，它不起作用）。

最后，您还可以使用 name 来过滤少数模块的文档字符串，同时保留其他模块的文档字符串。