Closed coretl closed 1 year ago
Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:
thanks @coretl for this update. Greatly appreciated. Sorry it has taken so long to loop around to it. We are currently in the process of updating a number of executable books
projects to sphinx5
so we can release the next version of jupyter book
.
@AakashGfude when running this through tox
and enforcing sphinx==5.3.0
there are a number of deprecation warnings we should attend to:
tests/test_sphinx.py: 47 warnings
/Users/mmcky/work/executablebooks/sphinx-external-toc/sphinx_external_toc/events.py:167: PendingDeprecationWarning: nodes.Node.traverse() is obsoleted by Node.findall().
for node in doctree.traverse(toctree_node):
tests/test_sphinx.py: 47 warnings
/Users/mmcky/work/executablebooks/sphinx-external-toc/sphinx_external_toc/events.py:177: PendingDeprecationWarning: nodes.Node.traverse() is obsoleted by Node.findall().
doctree.traverse(TableOfContentsNode)
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
Base: 91.02% // Head: 91.06% // Increases project coverage by +0.04%
:tada:
Coverage data is based on head (
89c03fa
) compared to base (2462700
). Patch coverage: 100.00% of modified lines in pull request are covered.
:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.
@chrisjsewell I went through this PR and updated it to resolve the warnings being issued by tox
for the docutils
issue around traverse
and findall
. Would you mind reviewing this PR?
Congrats on your first merged pull request in this project! :tada:
Thank you for contributing, we are very proud of you! :heart:
Sphinx 5 seems to work with sphinx-external-toc in my projects. This PR just enables it in pyproject.toml. The Contributing Guide seems to suggest the latest 2 major releases of sphinx should be supported, so maybe this should be
"sphinx>=4,<6"
instead?Fixes #83