python - 如何让 Sphinx 自动摘要显示实例属性的文档？

Question

所有其他类型(类、属性、方法等)工作正常，但当自动摘要获取实例属性时，它会引发“警告:无法导入 AClass.a”错误。奇怪的是，绘制的表格带有指向下面的 autodoc 代码文档的链接，但文档摘要列是空的。

有没有人有这个工作，或者有什么想法可能是错误的？

显示带有链接但没有文档的表格:

显示 autodoc 正在运行(如果没有它，上面的链接将无法实现):

我还尝试了其他形式的文档，例如 #: ... 样式等。结果都是一样的。同样，同一模块中的其他所有内容均有效。我确实在自动摘要表中看到了方法等方面的文档。

示例类:

class AClass(object):
    def __init__(self):
        self.a = 10
        """
        An example instance attribute

        :type: int
        """

示例 ReST:

.. autosummary::

    AClass.a

我正在使用 Sphinx 1.2.3

Answer 1

不幸的是，autosummary 根本不支持这一点。重要的代码位在 sphinx.ext.autosummary.__init__.AutoSummary.get_items 中，它本质上是:

for name in names:

    # <snip>

    try:
        real_name, obj, parent, modname = import_by_name(name, prefixes=prefixes)
    except ImportError:
        self.warn('failed to import %s' % name)
        items.append((name, '', '', name))
        continue

name 是 autosummary 指令下您要为其汇总的内容，因此在您的情况下是 "AClass.a"。但是，由于实例属性不可导入，并且 import_by_name 尝试导入名称，因此失败。我不知道为什么实现者会这样做，但我们开始了。

不过，如果您有时间和意愿，应该可以解决这个问题!我打开了an issue跟踪它。