从 Sphinx autodoc 扩展中的文档中排除静态成员答案

【问题标题】：Exclude static members from documentation in Sphinx autodoc extension从 Sphinx autodoc 扩展中的文档中排除静态成员
【发布时间】：2017-07-20 09:35:46
【问题描述】：

我正在使用 Sphinx autodoc 扩展来记录我的 Python 项目。我的课程文档中有以下内容：

.. automodule:: ClassName
    :members:
    :undoc-members:
    :show-inheritance:

我正在记录的类具有我不想包含在文档中的静态成员。有什么办法吗？

【问题讨论】：

标签： python python-sphinx autodoc

【解决方案1】：

请参阅.. automodule:: 下的选项:exclude-members: 的文档了解用法。

您需要添加选项:exclude-members: member1, member2

【讨论】：

我已经检查了:exclude-members: 的文档，但是使用它只能排除单个成员名称。我有大约 6-7 个静态方法，我需要一次排除它们。
我认为你误解了意思。用逗号分隔单个成员，即:exclude-members: member1, member2
好的。但是有什么方法可以说排除所有静态成员而不必一一提及？
不是我直接知道的。您可以从静态成员中删除文档字符串，然后从 reST 源中删除 :undoc-members:，但这很麻烦。建议 submitting an issue 讨论将此功能添加到 Sphinx，或搜索问题跟踪器以查看它是否已被建议或解决。
静态方法类型的表示返回<class function>，而不是普通方法的<class method>。示例：print(type(myclass.mystaticmethod)) 我认为模块 inspect（Python 自省 API）应该提供更多更好的细节。另请参阅：stackoverflow.com/questions/8727059/…