Include Titles in FileItems

Author: bame-da

sphinx_external_toc/api.py

@@ -16,14 +16,18 @@
 #: Pattern used to match URL items.
 URL_PATTERN: str = r".+://.*"
 
-
-class FileItem(str):
+@dataclass(**DC_SLOTS)
+class FileItem:
     """A document path in a toctree list.
 
     This should be in POSIX format (folders split by ``/``), relative to the
     source directory, and can be with or without an extension.
     """
-
+    path: str = field(validator=[instance_of(str)])
+    title: Optional[str] = field(default=None, validator=optional(instance_of(str)))
+    
+    def __post_init__(self):
+        validate_fields(self)
 
 class GlobItem(str):
     """A document glob in a toctree list."""

sphinx_external_toc/events.py

@@ -251,10 +251,8 @@ def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
                 subnode["entries"].append((entry.title, entry.url))
 
             elif isinstance(entry, FileItem):
-
-                child_doc_item = site_map[entry]
-                docname = str(entry)
-                title = child_doc_item.title
+                docname = entry.path
+                title = entry.title
 
                 docname = remove_suffix(docname, app.config.source_suffix)
 

sphinx_external_toc/parsing.py

@@ -238,7 +238,7 @@ def _parse_doc_item(
 
             try:
                 if link_keys == {FILE_KEY}:
-                    items.append(FileItem(item_data[FILE_KEY]))
+                    items.append(FileItem(item_data[FILE_KEY], item_data.get("title")))
                 elif link_keys == {GLOB_KEY}:
                     items.append(GlobItem(item_data[GLOB_KEY]))
                 elif link_keys == {URL_KEY}: