Fix TocTree manipulation on Sphinx 7.2+ #1406
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drammock
reviewed
Aug 14, 2023
src/pydata_sphinx_theme/toctree.py
Outdated
| from bs4 import BeautifulSoup | ||
| from docutils import nodes | ||
| from docutils.nodes import Node | ||
| from sphinx import addnodes | ||
| from sphinx.addnodes import toctree as toctree_node | ||
| from sphinx.application import Sphinx | ||
| from sphinx.environment.adapters.toctree import TocTree | ||
| from sphinx.environment.adapters.toctree import _get_toctree_ancestors, TocTree |
There was a problem hiding this comment.
you'll need to version-guard this import too:
Running Sphinx v5.3.0
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/pydata-sphinx-theme/envs/1406/lib/python3.9/site-packages/sphinx/config.py", line 350, in eval_config_file
exec(code, namespace)
File "/home/docs/checkouts/readthedocs.org/user_builds/pydata-sphinx-theme/checkouts/1406/docs/conf.py", line 14, in <module>
import pydata_sphinx_theme
File "/home/docs/checkouts/readthedocs.org/user_builds/pydata-sphinx-theme/envs/1406/lib/python3.9/site-packages/pydata_sphinx_theme/__init__.py", line 15, in <module>
from . import edit_this_page, logo, pygment, short_link, toctree, translator, utils
File "/home/docs/checkouts/readthedocs.org/user_builds/pydata-sphinx-theme/envs/1406/lib/python3.9/site-packages/pydata_sphinx_theme/toctree.py", line 14, in <module>
from sphinx.environment.adapters.toctree import _get_toctree_ancestors, TocTree
ImportError: cannot import name '_get_toctree_ancestors' from 'sphinx.environment.adapters.toctree' (/home/docs/checkouts/readthedocs.org/user_builds/pydata-sphinx-theme/envs/1406/lib/python3.9/site-packages/sphinx/environment/adapters/toctree.py)
drammock
reviewed
Aug 14, 2023
drammock
reviewed
Aug 14, 2023
|
thanks @AA-Turner |
|
Thank you! To make you aware, Sphinx 7.2 is planned for release this week, so users of A |
|
thanks for the heads-up. We're overdue for a release anyway so I'll try to wrap up our remaining blockers ASAP |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #1404
This is the bare minimum required to restore the previous state. I intend to look into how
pydata-sphinx-themeusesget_toctree_ancestorsand if there are any longer-term improvements to be made.A