Commit 329dcb4
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
102 | | - | |
103 | | - | |
104 | | - | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
110 | 101 | | |
111 | 102 | | |
112 | 103 | | |
| |||
123 | 114 | | |
124 | 115 | | |
125 | 116 | | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
126 | 133 | | |
127 | 134 | | |
128 | | - | |
129 | 135 | | |
0 commit comments