Отключение отдельных предупреждений Sphinx

Question

У меня много .rst файлы в моем дереве Сфинкса, которые намеренно исключены из любого дерева индексов. Я получаю предупреждения как

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

Как я могу подавить определенные предупреждения в Сфинксе?

Answer 1

1. Есть ли в вашем проекте Sphinx файлы.rst, содержимое которых вы не хотите выводить?

   Использовать exclude_patterns переменная конфигурации. Выходные данные (и никакие предупреждающие сообщения) не будут генерироваться для файлов, соответствующих указанным шаблонам. Смотрите http://sphinx-doc.org/config.html.

2. Есть ли в вашем проекте Sphinx файлы.rst, которые не являются частью какого-либо дерева, но чей контент должен быть в выводе?

   добавлять :orphan: вверху каждого.rst файла, чтобы подавить предупреждающее сообщение. См. http://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html.