禁用单个 Sphinx 警告消息

Question

我的 Sphinx 树中有许多

.rst

文件，这些文件被有意从任何索引树中排除。我收到类似的警告

 /filename.rst:: WARNING: document isn't included in any toctree

如何抑制 Sphinx 中的特定警告？

Answer 1

1. 您的 Sphinx 项目中是否存在您不希望其内容出现在输出中的 .rst 文件？

   使用

   exclude_patterns

   配置变量。对于匹配指定模式的文件，不会生成任何输出（也不会生成警告消息）。请参阅 http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patterns。

2. 您的 Sphinx 项目中是否存在不属于任何目录树但其内容应在输出中的 .rst 文件？

   在每个 .rst 文件的顶部添加

   :orphan:

   以抑制警告消息。请参阅 http://www.sphinx-doc.org/en/master/usage/restructedtext/field-lists.html#file-wide-metadata

您还可以使用 https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings

Answer 2

我可以通过在

conf.py

文件中添加以下配置来解决此问题

suppress_warnings = [
    'toc.not_readable',  # Suppress warnings about excluded toctree entries
]