python-sphinxrestructuredtexttoctree

WARNING: document isn't included in any toctree for included file

I'm getting the warning:

WARNING: document isn't included in any toctree

for files that exist in the document because they've been explicitly included. So I have the index file:

.. toctree::
    :maxdepth: 2

   pages/0010-foo
   pages/0020-bar

In the file 0020-bar.rst, I'm specifically including a number of other files, as in:

.. contents:: :local:

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

But when I build the project, I still get a warning that 0070-baz.rst isn't in any toctree, as in:

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

The weird thing is that I can see the content in the output. Is this normal? Does this warning always appear for files that are explicitly included rather than included via toctree?

Solution

  • Sphinx will complain about this whether the file is included or not.

    However, you can specifically exclude files by using the exclude_patterns config value.

    So for your case you might try to change Sphinx's conf.py file with something like:

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

    You can exclude individual files, directories, or use file globbing patterns to match groups of files this way.

    EDIT: See: Joakim's answer for another option that was added after this answer was created.