Предупреждение: документ не включен в любой toctree для включенного файла
Я получаю предупреждение:
WARNING: document isn't included in any toctree
для файлов, которые существуют в документе, потому что они были явно включены. Итак, у меня есть индексный файл:
.. toctree::
:maxdepth: 2
pages/0010-foo
pages/0020-bar
в файле 0020-bar.во-первых, я специально включаю ряд других файлов, как в:
.. contents:: :local:
.. include:: /pages/reference-architecture/technical-considerations/0070-baz.rst
но когда я строю проект, я все равно получаю предупреждение, что 0070-баз.во-первых, нет ни в одном toctree, как в:
/home/nick/Documents/myProject/docs/pages/reference-architecture/technical-considerations/0070-baz.rst:: WARNING: document isn't included in any toctree
странно то, что я могу видеть содержимое на выходе. Это нормально? Всегда ли это предупреждение появляется для файлов, которые явно включены, а не включены через toctree?
спасибо!
3 ответов
Sphinx будет жаловаться на это, включен ли файл или нет.
однако, вы можете исключить файлы с помощью exclude_patterns значение конфигурации.
поэтому для вашего случая вы можете попробовать что-то вроде:
exclude_patterns = ['pages/reference-architecture', some/other/file.txt]
можно исключить отдельные файлы, каталоги или использовать файл подстановка шаблонов для поиска группы файлов таким образом.
Если вы хотите ..include:: документ в другом документе, без его появления в любом toctree.
добавить :orphan: в верхней части документа, чтобы избавиться от предупреждения.
Это метаданных, Подробнее см. здесь:
http://www.sphinx-doc.org/en/1.4.8/markup/misc.html#metadata