Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specifically handle apidoc generated files #36

Open
chrisjsewell opened this issue Jun 7, 2021 · 1 comment
Open

Specifically handle apidoc generated files #36

chrisjsewell opened this issue Jun 7, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@chrisjsewell
Copy link
Member

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"

@mikofski
Copy link

mikofski commented Feb 6, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants