readthedocs / sphinx-autoapi

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

Remove ability to add domains to the toctree #374

Closed BrandonWiebe closed 1 year ago

BrandonWiebe commented 1 year ago

Sphinx 5.2.0 adds domain objects to the toctree by default. This is causing duplicate entries to appear in the table of contents when autoapi is in use, since autoapi also adds domain objects to the toctree by default (e.g. #369). It seems sensible to allow sphinx to handle the addition of domain objects to the toctree instead of post-processing it ourselves in autoapi.

If merged, this PR will cause autoapi to defer to sphinx to handle adding domain objects to the toctree.