Toggleable ToC

AA-Turner · AA-Turner · commit 67355b2e3d9e · 2022-03-13T15:25:09.000Z
diff --git a/pep_sphinx_extensions/pep_processor/html/pep_html_builder.py b/pep_sphinx_extensions/pep_processor/html/pep_html_builder.py
@@ -38,6 +38,7 @@ def get_doc_context(self, docname: str, body: str, _metatags: str) -> dict:
         toc_tree = self.env.tocs[docname].deepcopy()
         if len(toc_tree[0]) > 1:
             toc_tree = toc_tree[0][1]  # don't include document title
+            del toc_tree[0]  # remove contents node
             for node in toc_tree.findall(nodes.reference):
                 node["refuri"] = node["anchorname"] or '#'  # fix targets
             toc = self.render_partial(toc_tree)["fragment"]
diff --git a/pep_sphinx_extensions/pep_processor/html/pep_html_translator.py b/pep_sphinx_extensions/pep_processor/html/pep_html_translator.py
@@ -89,6 +89,17 @@ def depart_label(self, node) -> None:
         # Close the def tags
         self.body.append("</dt>\n<dd>")
 
+    def visit_bullet_list(self, node):
+        if isinstance(node.parent, nodes.section) and "contents" in node.parent["names"]:
+            self.body.append("<details><summary>Contents</summary>")
+            self.context.append("</details>")
+        super().visit_bullet_list(node)
+
+    def depart_bullet_list(self, node):
+        super().depart_bullet_list(node)
+        if isinstance(node.parent, nodes.section) and "contents" in node.parent["names"]:
+            self.body.append(self.context.pop())
+
     def unknown_visit(self, node: nodes.Node) -> None:
         """No processing for unknown node types."""
         pass
diff --git a/pep_sphinx_extensions/pep_processor/transforms/pep_contents.py b/pep_sphinx_extensions/pep_processor/transforms/pep_contents.py
@@ -17,8 +17,7 @@ def apply(self) -> None:
         if not Path(self.document["source"]).match("pep-*"):
             return  # not a PEP file, exit early
         # Create the contents placeholder section
-        title = nodes.title("", "", nodes.Text("Contents"))
-        contents_section = nodes.section("", title)
+        contents_section = nodes.section("")
         if not self.document.has_name("contents"):
             contents_section["names"].append("contents")
         self.document.note_implicit_target(contents_section)
diff --git a/pep_sphinx_extensions/pep_theme/static/style.css b/pep_sphinx_extensions/pep_theme/static/style.css
@@ -118,6 +118,11 @@ pre {
     padding: .5rem .75rem;
 }
 
+/* Contents rules */
+details > summary > h2 {
+    font-weight: bold;
+}
+
 /* Definition list rules */
 dl dt {
     font-weight: bold;
