DOP-2300: Correct recursive directive parsing line offsets

Author: i80and

snooty/rstparser.py

@@ -533,7 +533,7 @@ def run(self) -> List[docutils.nodes.Node]:
 
         # Parse the content
         self.state.nested_parse(
-            self.content, self.state_machine.line_offset, node, match_titles=True
+            self.content, self.content_offset, node, match_titles=True
         )
 
         return [node]
@@ -557,7 +557,7 @@ def parse_argument(self, node: directive, source: str, line: int) -> None:
             content_lines = prepare_viewlist(self.arguments[0])
             self.state.nested_parse(
                 docutils.statemachine.ViewList(content_lines, source=self.arguments[0]),
-                self.state_machine.line_offset,
+                self.content_offset,
                 node,
                 match_titles=True,
             )
@@ -757,7 +757,7 @@ def make_tab_node(
         content_lines = prepare_viewlist(child.content)
         self.state.nested_parse(
             docutils.statemachine.ViewList(content_lines, source=source),
-            self.state_machine.line_offset,
+            self.content_offset,
             node,
             match_titles=True,
         )
@@ -826,7 +826,7 @@ def run(self) -> List[docutils.nodes.Node]:
 
         if self.content:
             self.state.nested_parse(
-                self.content, self.state_machine.line_offset, node, match_titles=True
+                self.content, self.content_offset, node, match_titles=True
             )
 
         return [node]

snooty/test_parser.py

@@ -2653,3 +2653,37 @@ def test_escape() -> None:
     <paragraph><substitution_reference name="adl"></substitution_reference><text>ss</text></paragraph>
 </root>""",
     )
+
+
+def test_directive_line_offset() -> None:
+    """Ensure that line numbers are correctly tracked inside of directives."""
+    path = ROOT_PATH.joinpath(Path("test.rst"))
+    project_config = ProjectConfig(ROOT_PATH, "")
+    parser = rstparser.Parser(project_config, JSONVisitor)
+
+    page, diagnostics = parse_rst(
+        parser,
+        path,
+        r""".. _kotlin-multiplatform-install:
+
+========================================
+Install Realm - Kotlin Multiplatform SDK
+========================================
+
+.. default-domain:: mongodb
+
+Prerequisites
+-------------
+
+.. warning::
+
+   You can track an issue with line numbers in :github:`this GitHub issue
+   <https://github.com/mongodb/snooty-parser/pull/328>`__.
+
+.. include:: /includes/steps/install-kotlin-multiplatform.rst
+""",
+    )
+
+    page.finish(diagnostics)
+    assert len(diagnostics) == 1
+    assert diagnostics[0].start[0] == 13