带有toctree的自动摘要还列出了导入的成员

Question

我使用Sphinx和自动摘要来生成Python软件的文档。它运行良好，但是生成的.rst文件也列出了导入的函数和类，这不是我想要的行为。

例如，带有文档字符串的软件包“ packageex”：

"""
Package Example (:mod:`packageex`)
==================================

.. currentmodule:: packageex
.. autosummary::
   :toctree:

   module0
   module1
"""

将产生一个文件packageex.module0.rst与

Module0 (:mod:`packageex.module0`)
=================================

.. currentmodule:: packageex.module0

.. rubric:: Functions

.. autosummary::

   f0
   f1
   f2_imported
   f3_imported

.. rubric:: Classes

.. autosummary::

   Class0
   ClassImported

是否有办法只列出模块中定义的功能和类（而不列出那些导入的功能和类？

在autodoc（http://sphinx-doc.org/latest/ext/autodoc.html）的doc中，存在“在“ automodule”指令中设置了“ members”选项的情况，仅记录其__module__属性等于给定automodule的模块名称的模块成员。这是防止记录导入的类或函数。如果要防止这种行为并记录所有可用的成员，请设置imported-members选项。请注意，将不会记录来自导入模块的属性，因为属性文档是通过分析源文件发现的当前模块。” autosummary是否有可能获得相同的行为？

Answer 1

如mzjn所提到，扩展自动摘要似乎是一个已知的奇怪行为。为了得到想要的行为（即，防止列出导入的对象），我刚刚修改了函数get_members（sphinx.ext.autosummary.generate的第166条），如下所示：

def get_members(obj, typ, include_public=[], imported=False):
    items = []
    for name in dir(obj):
        try:
            obj_name = safe_getattr(obj, name)
            documenter = get_documenter(obj_name, obj)
        except AttributeError:
            continue
        if documenter.objtype == typ:
            try:
                cond = (
                    imported or 
                    obj_name.__module__ == obj.__name__
                    )
            except AttributeError:
                cond = True
            if cond:
                items.append(name)
    public = [x for x in items
              if x in include_public or not x.startswith('_')]
    return public, items