Skip to content

Commit d5966e7

Browse files
committed
docs(api[sidebar]): restore core module pages to sidebar navigation
why: The Library Skeleton redesign replaced toctree entries with sphinx-design grid cards for core modules. Grid cards are purely visual links — Sphinx only registers pages in the nav tree via toctree directives, so the modules became orphaned (accessible by URL but absent from the sidebar). what: - Add hidden toctree in docs/api/index.md listing all 10 core and supporting modules (server, session, window, pane, common, neo, options, hooks, constants, exc) - :hidden: preserves grid cards as visual entry point while restoring sidebar navigation
1 parent 5cc1a6f commit d5966e7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/api/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,22 @@ Exception hierarchy.
8484

8585
::::
8686

87+
```{toctree}
88+
:hidden:
89+
:maxdepth: 1
90+
91+
libtmux.server
92+
libtmux.session
93+
libtmux.window
94+
libtmux.pane
95+
libtmux.common
96+
libtmux.neo
97+
libtmux.options
98+
libtmux.hooks
99+
libtmux.constants
100+
libtmux.exc
101+
```
102+
87103
## Test Utilities
88104

89105
If you're testing code that uses libtmux, see the test helpers and pytest plugin:

0 commit comments

Comments
 (0)