Подтвердить что ты не робот

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

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

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

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

4b9b3361

Ответ 1

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

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

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

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