🐛 FIX: gettext builder compatibility

Author: chrisjsewell

sphinx_external_toc/events.py

@@ -153,7 +153,9 @@ class TableofContents(SphinxDirective):
     # TODO allow for name option of tableofcontents (to reference it)
     def run(self) -> List[TableOfContentsNode]:
         """Insert a ``TableOfContentsNode`` node."""
-        return [TableOfContentsNode()]
+        node = TableOfContentsNode()
+        self.set_source_info(node)
+        return [node]
 
 
 def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
@@ -220,7 +222,8 @@ def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
 
         subnode = toctree_node()
         subnode["parent"] = app.env.docname
-        subnode.source = doctree.source
+        subnode.source = doctree["source"]
+        subnode.line = 1
         subnode["entries"] = []
         subnode["includefiles"] = []
         subnode["maxdepth"] = toctree.maxdepth

tests/test_sphinx.py

@@ -81,6 +81,24 @@ def test_success(path: Path, tmp_path: Path, sphinx_build_factory, file_regressi
         file_regression.check(doctree.pformat(), extension=".xml", encoding="utf8")
 
 
+def test_gettext(tmp_path: Path, sphinx_build_factory):
+    """Test the gettext builder runs correctly."""
+    src_dir = tmp_path / "srcdir"
+    # write document files
+    toc_path = Path(__file__).parent.joinpath("_toc_files", "basic.yml")
+    create_site_from_toc(toc_path, root_path=src_dir, toc_name=None)
+    # write conf.py
+    content = f"""
+extensions = ["sphinx_external_toc"]
+external_toc_path = {Path(os.path.abspath(toc_path)).as_posix()!r}
+
+"""
+    src_dir.joinpath("conf.py").write_text(content, encoding="utf8")
+    # run sphinx
+    builder = sphinx_build_factory(src_dir, buildername="gettext")
+    builder.build()
+
+
 @pytest.mark.parametrize(
     "path", TOC_FILES_WARN, ids=[path.name.rsplit(".", 1)[0] for path in TOC_FILES_WARN]
 )