python-sphinx - the - sphinx ejemplo

ADVERTENCIA: el documento no está incluido en ningún toctree para el archivo incluido

Question

Estoy recibiendo la advertencia:

WARNING: document isn''t included in any toctree

para los archivos que existen en el documento porque se han incluido explícitamente. Así que tengo el archivo de índice:

.. toctree::
:maxdepth: 2
pages/0010-foo
pages/0020-bar

En el archivo 0020-bar.rst, estoy incluyendo específicamente varios otros archivos, como en:

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

Pero cuando compilo el proyecto, todavía recibo una advertencia de que 0070-baz.rst no está en ningún toctree, como en:

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

Lo extraño es que puedo ver el contenido en la salida. ¿Esto es normal? ¿Aparece siempre esta advertencia para los archivos que se incluyen explícitamente en lugar de incluirlos a través de toctree?

¡Gracias!

Answer 1

La sangría funcionó:

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

Answer 2

Si solo desea ..include:: un documento en otro documento, sin que aparezca en ningún toctree .

Agregue :orphan: en la parte superior de su documento para deshacerse de la advertencia.

Esta es una opción de metadatos de todo el archivo , vea más aquí:

http://www.sphinx-doc.org/en/1.4.8/markup/misc.html#metadata

Answer 3

Sphinx se quejará de esto si el archivo está incluido o no.

Sin embargo, puede excluir específicamente los archivos utilizando el valor de configuración exclude_patterns .

Entonces, para tu caso, podrías probar algo como:

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

Puede excluir archivos individuales, directorios o usar patrones de archivo de archivos para hacer coincidir grupos de archivos de esta manera.