为狮身人面像自动模块获取“扁平”成员输出

Question

我正在使用Sphinx autodoc扩展来对模块进行文档化，我想在文档输出中获得模块成员的flat列表。

我尝试使用以下内容：

.. automodule:: modname
   :members:

但是，这有两个问题：

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

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

但是，我找不到能够使我有选择地禁用这两个方面的配置选项，同时仍然获得所有模块成员的自动列表。

我目前的计划是仅使用自动功能（etc）并明确枚举要记录的成员，但是我仍然想知道是否错过了实现原本想要的简单方法的方法。

更新：

我至少找到了第二部分的解决方法：在add_module_names=False中设置conf.py。不过，这是一个全局设置，因此它并不能真正回答我的原始问题。我正在使用Sphinx autodoc扩展来对模块进行文档化，并且我希望在文档输出中获得模块成员的完整列表。我尝试使用以下内容：.. automodule :: modname ...

Answer 1

考虑类似问题的answer，我发现您可以使用autodoc-process-docstring事件从模块中删除文档字符串，并将以下代码附加到autodoc-process-docstring：