Sphinx 自动摘要：数据类继承

Question

以下代码使Sphinx AutoSummary失败：

@dataclasses.dataclass
class Foo:
    bar: int


class FooChild(Foo):
    pass

我的autosummary模板（ _templates/autosummary/class.rst ）：

{{ name | escape | underline}}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
   :members:

   {% block attributes %}
   {% if attributes %}
   .. rubric:: {{ _('Attributes') }}

   .. autosummary::
   {% for item in attributes %}
      ~{{ name }}.{{ item }}
   {%- endfor %}
   {% endif %}
   {% endblock %}

运行 sphinx -build -j 2 -w -b html docs/gh docs/gh pogs docs/gh pages 我会遵循警告：

Warning, treated as error:
~/path/docs/generated/module.FooChild.rst:14:autosummary: 
failed to import FooChild.bar.

我需要将警告视为错误，因为否则我的项目中的文档会很快降级，但是我想修复此根本原因或忽略此特定的警告。

我找不到任何方法可以忽略源代码注释中的警告，也不能选择性地抑制狮身人面像配置中的警告。请帮忙！

编辑： 这是生成的 foochild.rst 文件看起来像：

FooChild
========
.. currentmodule:: package.module

.. autoclass:: FooChild
   :members:

   .. rubric:: Attributes
   .. autosummary::
      ~FooChild.bar

我有一个 conf.py 将 api.rst 添加到toctree， api。 RST 旨在触发自室以创建所有模块和类创建文档，在此示例中，只有 module.py.py 。

API Overview
************

.. currentmodule:: package
.. autosummary::
   :toctree: generated
   :recursive:

   module

Answer 1

虽然它没有修复根本原因，但是您要求一种忽略此警告的方法：

您可以在模块中添加 __所有__ ，但不包括 foochild 。这样，AutoSummary将忽略它。

来自文档 autosummary_ignore_module_all ：

如果false和一个模块具有 __所有__ 属性集，则在 __ ALL __ ALL __ 中列出的每个成员，也没有其他成员。默认值为true

请注意，如果在 __ All __ 中列出导入的成员，则无论AutoSummary_imported_members的价值如何，都将记录在记录中。要匹配来自模块导入 *的行为 *，请将autosummary_ignore_module_all设置为false和autosummary_imported_members true。

版本4.4中的新事物。