Add style and restart_numbering to toctree data

Added 'style' and 'restart_numbering' fields to toctree structures in YAML and XML test files to support new features. Updated TocTreeCollectorWithStyles to skip non-internal document references when fixing nested toctrees. This improves handling of toctree options and ensures correct processing of document references.

Author: douden

sphinx_external_toc/collectors.py

@@ -256,6 +256,10 @@ def __replace_toc(self, env, ref, node, style):
 
     def __fix_nested_toc(self, env, toctree, style):
         for _, ref in toctree["entries"]:
+            # Only process internal document references
+            if ref not in env.titles:
+                continue
+
             if "secnumber" not in env.titles[ref]:
                 continue
             new_secnumber = self.__renumber(

tests/test_parsing/test_file_to_sitemap_basic_.yml

@@ -18,7 +18,9 @@ documents:
         url: https://example.com
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: true
     title: null
   intro:
@@ -32,7 +34,9 @@ documents:
       - doc3
       maxdepth: -1
       numbered: true
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: true
     title: null
   subfolder/doc4:

tests/test_parsing/test_file_to_sitemap_basic_compressed_.yml

@@ -18,7 +18,9 @@ documents:
         url: https://example.com
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: true
     title: null
   doc4:
@@ -36,7 +38,9 @@ documents:
       - doc3
       maxdepth: -1
       numbered: true
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: true
     title: null
 meta:

tests/test_parsing/test_file_to_sitemap_exclude_missing_.yml

@@ -13,7 +13,9 @@ documents:
       - subfolder/other*
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: false
     title: null
 meta:

tests/test_parsing/test_file_to_sitemap_glob_.yml

@@ -8,7 +8,9 @@ documents:
       - doc*
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: false
     title: null
 meta:

tests/test_parsing/test_file_to_sitemap_nested_.yml

@@ -17,7 +17,9 @@ documents:
       - folder/globfolder/*
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: false
     title: null
   folder/subfolder/doc4:
@@ -35,7 +37,9 @@ documents:
       - folder/doc3
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: false
     title: null
 meta:

tests/test_parsing/test_file_to_sitemap_tableofcontents_.yml

@@ -16,15 +16,19 @@ documents:
       - doc1
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: false
     - caption: null
       hidden: true
       items:
       - doc2
       maxdepth: -1
       numbered: false
+      restart_numbering: null
       reversed: false
+      style: numerical
       titlesonly: false
     title: null
 meta:

tests/test_sphinx/test_success_basic_.xml

@@ -3,4 +3,4 @@
         <title>
             Heading: intro.rst
         <compound classes="toctree-wrapper">
-            <toctree caption="Part Caption" entries="(None,\ 'doc1') (None,\ 'doc2') (None,\ 'doc3')" glob="False" hidden="True" includefiles="doc1 doc2 doc3" includehidden="False" maxdepth="-1" numbered="999" parent="intro" rawcaption="Part Caption" titlesonly="True">
+            <toctree caption="Part Caption" entries="(None,\ 'doc1') (None,\ 'doc2') (None,\ 'doc3')" glob="False" hidden="True" includefiles="doc1 doc2 doc3" includehidden="False" maxdepth="-1" numbered="999" parent="intro" rawcaption="Part Caption" restart_numbering="True" style="numerical" titlesonly="True">

tests/test_sphinx/test_success_basic_compressed_.xml

@@ -3,4 +3,4 @@
         <title>
             Heading: intro.rst
         <compound classes="toctree-wrapper">
-            <toctree caption="True" entries="(None,\ 'doc1') (None,\ 'doc2') (None,\ 'doc3')" glob="False" hidden="True" includefiles="doc1 doc2 doc3" includehidden="False" maxdepth="-1" numbered="999" parent="intro" rawcaption="" titlesonly="True">
+            <toctree caption="True" entries="(None,\ 'doc1') (None,\ 'doc2') (None,\ 'doc3')" glob="False" hidden="True" includefiles="doc1 doc2 doc3" includehidden="False" maxdepth="-1" numbered="999" parent="intro" rawcaption="" restart_numbering="True" style="numerical" titlesonly="True">

tests/test_sphinx/test_success_tableofcontents_.xml

@@ -3,6 +3,6 @@
         <title>
             Heading: intro.rst
         <compound classes="toctree-wrapper">
-            <toctree caption="True" entries="(None,\ 'doc1')" glob="False" hidden="False" includefiles="doc1" includehidden="False" maxdepth="-1" numbered="0" parent="intro" rawcaption="" titlesonly="False">
+            <toctree caption="True" entries="(None,\ 'doc1')" glob="False" hidden="False" includefiles="doc1" includehidden="False" maxdepth="-1" numbered="0" parent="intro" rawcaption="" restart_numbering="True" style="numerical" titlesonly="False">
         <compound classes="toctree-wrapper">
-            <toctree caption="True" entries="(None,\ 'doc2')" glob="False" hidden="False" includefiles="doc2" includehidden="False" maxdepth="-1" numbered="0" parent="intro" rawcaption="" titlesonly="False">
+            <toctree caption="True" entries="(None,\ 'doc2')" glob="False" hidden="False" includefiles="doc2" includehidden="False" maxdepth="-1" numbered="0" parent="intro" rawcaption="" restart_numbering="True" style="numerical" titlesonly="False">