4

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

4

1 回答 1

5

正如 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
于 2014-08-23T10:04:45.440 回答