Question

我使用Sphinx和autosummary来生成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）的文档中，“在一个自动模块指令中设置了成员选项，只有__module__属性等于给自动模块的模块名称的模块成员将这是为了防止导入类或函数的文档。如果要防止此行为并记录所有可用成员，请设置imported-members选项。请注意，导入模块中的属性不会被记录，因为属性文档是由解析当前模块的源文件。“是否有可能在autosummary中获得相同的行为？

Answer 1

正如mzjn所提到的，它似乎是扩展autosummary的一个已知的奇怪行为。为了获得想要的行为（即防止导入对象的列表），我刚刚修改了函数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

带有toctree的sphinx autosummary还列出了导入的成员

1 个答案: