Skip to content

Commit 329dcb4

Browse files
committed
docs(sidebar[tiers]): regroup into Domain/UX/Utils/Internal
why: "Shared Infrastructure" bundled three heterogenous packages under one caption — sphinx-ux-badges and sphinx-ux-autodoc-layout are visual/styling primitives that naturally belong alongside sphinx-fonts, while sphinx-autodoc-typehints-gp is a type-rendering utility that doesn't fit either. The single generic caption made it hard for a reader browsing the sidebar to reason about what each package is for at a glance. Split into four purpose-named captions so the navigation matches the conceptual categories. what: - docs/index.md: replace the three hidden toctrees (Shared Infrastructure / Domain Packages / UX) with four captioned toctrees: * Domain Packages — the six autodoc-* extensions (unchanged). * UX — sphinx-fonts, sphinx-ux-autodoc-layout, sphinx-ux-badges (the three visual/styling primitives). * Utils — sphinx-autodoc-typehints-gp (type-rendering utility that replaces sphinx-autodoc-typehints + sphinx.ext.napoleon). * Internal — gp-sphinx (metapackage / coordinator) and sphinx-gp-theme (furo sub-theme), the two packages readers don't install on their own. - Alphabetise entries within each toctree for predictability. - No narrative (docs/architecture.md, docs/packages/index.md) changes in this commit; the architecture tiers describe dependency layers and remain three-tier, while the sidebar captions describe navigation buckets.
1 parent c598dce commit 329dcb4

1 file changed

Lines changed: 16 additions & 10 deletions

File tree

docs/index.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,15 +98,6 @@ project/index
9898
history
9999
```
100100

101-
```{toctree}
102-
:caption: Shared Infrastructure
103-
:hidden:
104-
105-
packages/sphinx-ux-badges
106-
packages/sphinx-ux-autodoc-layout
107-
packages/sphinx-autodoc-typehints-gp
108-
```
109-
110101
```{toctree}
111102
:caption: Domain Packages
112103
:hidden:
@@ -123,7 +114,22 @@ packages/sphinx-autodoc-sphinx
123114
:caption: UX
124115
:hidden:
125116
117+
packages/sphinx-fonts
118+
packages/sphinx-ux-autodoc-layout
119+
packages/sphinx-ux-badges
120+
```
121+
122+
```{toctree}
123+
:caption: Utils
124+
:hidden:
125+
126+
packages/sphinx-autodoc-typehints-gp
127+
```
128+
129+
```{toctree}
130+
:caption: Internal
131+
:hidden:
132+
126133
packages/gp-sphinx
127134
packages/sphinx-gp-theme
128-
packages/sphinx-fonts
129135
```

0 commit comments

Comments
 (0)