带有目录树的自动摘要还列出导入的成员

Question

我使用Sphinx和autosummary生成Python软件的文档。它工作得很好，但是生成的.rst文件还列出了导入的函数和类，这不是我想要的行为

例如，带有docstring的包“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）的文档中，在带有members选项集的automodule指令中，只有__module__的模块成员属性等于将记录给automodule的模块名称。这是为了防止记录导入的类或函数。如果要防止此行为并记录所有可用的成员，请设置“导入的成员”选项。请注意，不会记录来自导入模块的属性，因为属性记录通过解析当前模块的源文件可以发现异常。“是否可以使用autosummary获得相同的行为？”

Answer 1

正如mzjn所提到的，这似乎是一种已知的自动摘要扩展的奇怪行为。为了获得所需的行为（即防止列出导入的对象），我刚刚修改了函数get_members（sphinx.ext.autosummary.generate的l.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