search

readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
432 stars 128 forks source link

`document isn't included in any toctree` #365

Closed hblumberg closed 1 year ago

hblumberg commented 1 year ago

Hello! I followed the Python tutorial here and am running into the following warning:

checking consistency... /docs/autoapi/index.rst: WARNING: document isn't included in any toctree

Is there any way to avoid this warning (without suppressing all warnings of this type)? Thank you!

hblumberg commented 1 year ago

I found that adding autoapi/index to index.rst (as follows) resolved this warning without changing the document structure.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   autoapi/index

Leaving this open in case there are better approaches!

AWhetter commented 1 year ago

This looks like a duplicate of #319, so I'll close this in favour of that issue.