禁用单个Sphinx警告消息 [英] Disabling individual Sphinx warning messages

问题描述

我的Sphinx树中有许多被有意从任何索引树中排除的.rst文件。我收到类似

的警告

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

如何在Sphinx中禁止显示特定警告？

推荐答案

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/restructuredtext/field-lists.html#file-wide-metadata

这篇关于禁用单个Sphinx警告消息的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！