🐛 FIX: File extensions in ToC (#44)

Ensure files are still matched, if they are provided with file extensions.

Author: chrisjsewell

sphinx_external_toc/events.py

@@ -76,9 +76,10 @@ def parse_toc_to_env(app: Sphinx, config: Config) -> None:
     config.external_site_map = site_map
 
     # Update the master_doc to the root doc of the site map
-    if config["master_doc"] != site_map.root.docname:
-        logger.info("[etoc] Changing master_doc to '%s'", site_map.root.docname)
-    config["master_doc"] = site_map.root.docname
+    root_doc = remove_suffix(site_map.root.docname, config.source_suffix)
+    if config["master_doc"] != root_doc:
+        logger.info("[etoc] Changing master_doc to '%s'", root_doc)
+    config["master_doc"] = root_doc
 
     if config["external_toc_exclude_missing"]:
         # add files not specified in ToC file to exclude list
@@ -181,6 +182,14 @@ def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
     site_map: SiteMap = app.env.external_site_map
     doc_item: Optional[Document] = site_map.get(app.env.docname)
 
+    # check for matches with suffix
+    # TODO check in sitemap, that we do not have multiple docs of the same name
+    # (strip extensions on creation)
+    for suffix in app.config.source_suffix:
+        if doc_item is not None:
+            break
+        doc_item = site_map.get(app.env.docname + suffix)
+
     if doc_item is None or not doc_item.subtrees:
         if toc_placeholders:
             create_warning(

tests/test_sphinx.py

@@ -112,3 +112,36 @@ def test_absolute_path(tmp_path: Path, sphinx_build_factory):
     # run sphinx
     builder = sphinx_build_factory(src_dir)
     builder.build()
+
+
+def test_file_extensions(tmp_path: Path, sphinx_build_factory):
+    """Test for tocs containing docnames with file extensions."""
+    src_dir = tmp_path / "srcdir"
+    src_dir.mkdir(exist_ok=True)
+    # write documents
+    src_dir.joinpath("intro.rst").write_text("Head\n====\n", encoding="utf8")
+    src_dir.joinpath("markdown.rst").write_text("Head\n====\n", encoding="utf8")
+    src_dir.joinpath("notebooks.rst").write_text("Head\n====\n", encoding="utf8")
+    # write toc
+    toc_path = tmp_path / "toc.yml"
+    toc_path.write_text(
+        """
+format: jb-book
+root: intro.rst
+chapters:
+- file: markdown.rst
+  sections:
+  - file: notebooks.rst
+    """,
+        encoding="utf8",
+    )
+    # 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)
+    builder.build()