Skip to content

Commit

Permalink
suppress sphinx spurious warning when auto-generating the API docs
Browse files Browse the repository at this point in the history
sphinx.errors.SphinxWarning: ../docs/reference/api.md::toctree directive not expected with external-toc [etoc.toctree]

This workaround is suggested here:
executablebooks/sphinx-external-toc#36

Until that bug and executablebooks/sphinx-external-toc#79 are fixed, we need this!
  • Loading branch information
otizonaizit committed Dec 9, 2024
1 parent 710f9f7 commit bbddc64
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ sphinx:
- sphinx.ext.autodoc

config:
suppress_warnings : ["etoc.toctree"] # Workaround for: https://github.com/executablebooks/sphinx-external-toc/issues/36
# and: https://github.com/executablebooks/sphinx-external-toc/issues/79
autodoc_default_options: {
"members": True, # Include module/class members.
"member-order": 'bysource', # Order members as in source file.
Expand Down

0 comments on commit bbddc64

Please sign in to comment.