sphinx-external-toc icon indicating copy to clipboard operation
sphinx-external-toc copied to clipboard

Specifically handle apidoc generated files

Open chrisjsewell opened this issue 3 years ago • 1 comments

files generated with sphinx-autodoc will inherently contain toctree directives, and so sphinx_external_toc will warn e.g.: apidoc/my_package.rst:7: WARNING: toctree directive not expected with external-toc [etoc.toctree]

You can currently work around this by including:

suppress_warnings = ["etoc.toctree"]

but that will then ignore any legitimate issues

so it would nice to be able to "mark" a file as "it is ok for this file and its children to contain toctree"

chrisjsewell avatar Jun 07 '21 22:06 chrisjsewell

FYI: this issue "toctree directive not expected with external-toc" also pops up using sphinx-tags

mikofski avatar Feb 06 '23 21:02 mikofski