在将Sphinx autodoc与列表类型的模块数据成员一起使用时，抑制自动生成的Cruft

Question

我正在尝试使用sphinx.ext.autodoc来记录模块数据成员，该成员是SomeType的对象列表：

class SomeType(object):
    pass

Foo = SomeType()
Bar = SomeType()

foo_bar = [Foo, Bar]

我的autodoc指令看起来像：

.. autodata:: foo_bar
  :annotation: List[SomeType]

  Important documentation.

但是生成的文档包含自动生成的文件。我希望在哪里看到文字：

Important documentation.

我改为看：

list() -> new empty list list(iterable) -> new list initialized from iterable’s items Important documentation.

如何抑制此输出？

Answer 1

这里有两个选项：

1. 在代码中添加一个空的"documentation comment"（或空的文档字符串）：

   #: 
   foo_bar = [Foo, Bar]
   

2. 从autodata指令中删除“重要文档”，并放在特殊注释中：

   #: Important documentation
   foo_bar = [Foo, Bar]