web-dev-qa-db-fra.com

AVERTISSEMENT: le document n'est inclus dans aucun des fichiers inclus

Je reçois l'avertissement:

WARNING: document isn't included in any toctree

pour les fichiers qui existent dans le document car ils ont été explicitement inclus. J'ai donc le fichier d'index:

.. toctree::
    :maxdepth: 2

   pages/0010-foo
   pages/0020-bar

Dans le fichier 0020-bar.rst, j'inclus spécifiquement un certain nombre d'autres fichiers, comme dans:

.. contents:: :local:

.. include:: /pages/reference-architecture/technical-considerations/0070-baz.rst

Mais lorsque je construis le projet, je reçois toujours un avertissement indiquant que 0070-baz.rst ne figure pas dans les noms de domaine, comme dans:

/home/nick/Documents/myProject/docs/pages/reference-architecture/technical-considerations/0070-baz.rst:: WARNING: document isn't included in any toctree

La chose étrange est que je peux voir le contenu dans la sortie. Est-ce normal? Cet avertissement apparaît-il toujours pour les fichiers explicitement inclus plutôt que inclus via toctree? 

Merci!

python-sphinxrestructuredtext
31
NickChase

Sphinx s'en plaindra, que le fichier soit inclus ou non.

Cependant, vous pouvez spécifiquement exclure des fichiers en utilisant la valeur exclude_patterns config.

Donc, pour votre cas, vous pourriez essayer quelque chose comme:

exclude_patterns = ['pages/reference-architecture', some/other/file.txt]

Vous pouvez exclure des fichiers individuels, des répertoires ou utiliser des modèles de regroupement de fichiers pour faire correspondre des groupes de fichiers de cette manière.

21
Kevin Horn

L'indentation a fonctionné:

  toctree::   
   :maxdepth: 2
       hello <h.rst>
       abc <your.rst>
1
diveinsky