pydata-sphinx-theme: Incompatibility with Sphinx dev

A Sphinx PR merged today (sphinx-doc/sphinx#11565) renamed TocTree.get_toctree_ancestors() to TocTree._get_toctree_ancestors(). This causes this theme to error here: https://github.com/pydata/pydata-sphinx-theme/blob/0956f2265aded42e238c3a5c6fe393b51a5f8001/src/pydata_sphinx_theme/toctree.py#L420

I don’t know whether you want to ask Sphinx if they intended to make that change in API, or you just want to work around it in the theme.

About this issue

  • Original URL
  • State: closed
  • Created a year ago
  • Comments: 18 (9 by maintainers)

Most upvoted comments

This can probably be closed now.

A

@AA-Turner we certainly appreciate you submitting a fix here, but unfortunately that doesn’t fully solve the problem because we have a couple of other blocker issues that are preventing us from pushing out a release on Sphinx’s schedule.

My 2 cents is that it’d be better for Sphinx to expose the toctree structure to themes such that they can do the code generation, instead of one-more-option for the tab-style layouts, that provides more flexibility and doesn’t require changes in Sphinx as the documentation site conventions/expectations evolve.