DOP-5589: Composable tutorials dynamic headings (#662)

* insert headings under composable tutorials into page options

* fix typing

Author: seungpark

snooty/postprocess.py

@@ -468,7 +468,7 @@ def enter_node(self, fileid_stack: FileIdStack, node: n.Node) -> None:
         node.refuri = refuri
 
 
-SelectorId = Dict[str, Union[str, "SelectorId"]]
+SelectorId = Dict[str, Union[str, Dict[str, str], "SelectorId"]]
 
 
 class ContentsHandler(Handler):
@@ -486,9 +486,11 @@ def __init__(self, context: Context) -> None:
         self.current_depth = 0
         self.has_contents_directive = False
         self.headings: List[ContentsHandler.HeadingData] = []
-        self.scanned_pattern: List[Tuple[str, str]] = []
+        self.scanned_pattern: List[Tuple[str, Union[str, Dict[str, str]]]] = []
 
-    def scan_pattern(self, arr: List[Tuple[str, str]]) -> SelectorId:
+    def scan_pattern(
+        self, arr: List[Tuple[str, Union[str, Dict[str, str]]]]
+    ) -> SelectorId:
         if not arr:
             return {}
         if len(arr) == 1:
@@ -533,6 +535,9 @@ def enter_node(self, fileid_stack: FileIdStack, node: n.Node) -> None:
                 self.scanned_pattern.append((node.name, node.options["id"]))
             elif node.name == "tab":
                 self.scanned_pattern.append((node.name, node.options["tabid"]))
+            elif node.name == "selected-content":
+                assert isinstance(node, n.ComposableContent)
+                self.scanned_pattern.append((node.name, node.selections))
 
         if isinstance(node, n.Directive) and node.name == "contents":
             if self.has_contents_directive:
@@ -573,7 +578,7 @@ def enter_node(self, fileid_stack: FileIdStack, node: n.Node) -> None:
 
     def exit_node(self, fileid_stack: FileIdStack, node: n.Node) -> None:
         if isinstance(node, n.Directive) and (
-            node.name == "method-option" or node.name == "tab"
+            node.name in ["method-option", "tab", "selected-content"]
         ):
             self.scanned_pattern.pop()
         if isinstance(node, n.Section):

snooty/test_postprocess.py

@@ -4166,6 +4166,72 @@ def test_tab_headings() -> None:
         ]
 
 
+def test_composable_headings() -> None:
+    with make_test(
+        {
+            Path(
+                "source/index.txt"
+            ): """
+.. contents:: On this page
+   :local:
+   :depth: 3
+
+======================
+This is the page title
+======================
+   
+.. composable-tutorial::
+   :options: interface, language
+   :defaults: driver, nodejs
+         
+   .. selected-content::
+      :selections: driver, nodejs
+
+      This is a title under selected content
+      --------------------------------------
+
+      This is another heading!
+      ~~~~~~~~~~~~~~~~~~~~~~~~~
+      
+""",
+        }
+    ) as result:
+        test_file_id = FileId("index.txt")
+        page = result.pages[test_file_id]
+        diagnostics = result.diagnostics[test_file_id]
+        assert len(diagnostics) == 0
+        assert page.ast.options.get("headings") == [
+            {
+                "depth": 2,
+                "id": "this-is-a-title-under-selected-content",
+                "title": [
+                    {
+                        "type": "text",
+                        "position": {"start": {"line": 17}},
+                        "value": "This is a title under selected content",
+                    }
+                ],
+                "selector_ids": {
+                    "selected-content": {"interface": "driver", "language": "nodejs"}
+                },
+            },
+            {
+                "depth": 3,
+                "id": "this-is-another-heading-",
+                "title": [
+                    {
+                        "type": "text",
+                        "position": {"start": {"line": 20}},
+                        "value": "This is another heading!",
+                    }
+                ],
+                "selector_ids": {
+                    "selected-content": {"interface": "driver", "language": "nodejs"}
+                },
+            },
+        ]
+
+
 def test_multi_page_tutorials() -> None:
     test_page_template = """
 .. multi-page-tutorial::