From ec3185373044c120298501dbe91444bdb6ccb04c Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Thu, 17 Aug 2023 15:52:36 +0100 Subject: [PATCH] Restore ``TocTree.get_toctree_ancestors()`` --- CHANGES | 2 ++ sphinx/environment/adapters/toctree.py | 3 +++ 2 files changed, 5 insertions(+) diff --git a/CHANGES b/CHANGES index 8af44b050a0..810063774d6 100644 --- a/CHANGES +++ b/CHANGES @@ -21,6 +21,8 @@ Bugs fixed This will be removed in Sphinx 9. * Restored calls to ``Builder.add_{css,js}_file()``, which several extensions relied upon. +* Restored the private API ``TocTree.get_toctree_ancestors()``, + which several extensions relied upon. Testing ------- diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index 327b44a30a6..e50d10b7783 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/sphinx/environment/adapters/toctree.py @@ -508,6 +508,9 @@ def resolve(self, docname: str, builder: Builder, toctree: addnodes.toctree, includehidden=includehidden, ) + def get_toctree_ancestors(self, docname: str) -> list[str]: + return [*_get_toctree_ancestors(self.env.toctree_includes, docname)] + def get_toc_for(self, docname: str, builder: Builder) -> Node: return document_toc(self.env, docname, self.env.app.builder.tags)