ENH: Make hidden toctrees append their content after everything else …

…in their section This fixes the problem reported at: http://stackoverflow.com/q/25276415/102441 http://stackoverflow.com/q/39110429/102441
sphinx-doc · Feb 23, 2020 · ac2571c · ac2571c
1 parent 26fc526
commit ac2571c
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py
@@ -202,9 +202,14 @@ def _entries_from_toctree(toctreenode: addnodes.toctree, parents: List[str],
                                     toplevel.pop(1)
                     # resolve all sub-toctrees
                     for subtocnode in toc.traverse(addnodes.toctree):
-                        if not (subtocnode.get('hidden', False) and
-                                not includehidden):
-                            i = subtocnode.parent.index(subtocnode) + 1
+                        is_hidden = subtocnode.get('hidden', False)
+                        if includehidden or not is_hidden:
+                            if is_hidden:
+                                # hidden entries always go last
+                                i = len(subtocnode.parent)
+                            else:
+                                # visible entries go after the toctree
+                                i = subtocnode.parent.index(subtocnode) + 1
                             for entry in _entries_from_toctree(
                                     subtocnode, [refdoc] + parents,
                                     subtree=True):