Skip to content

Commit d7d0f4c

Browse files
committed
docs(CHANGES): autodoc design system, workspace renames, Sphinx 8.1 floor
why: Record the breaking and feature-level shifts introduced by the autodoc-improvements branch so downstream alpha-testers can understand what changed before the next 0.0.1-series release cut. Kept terse — the package is still pre-1.0 and entries describe the net shipped result, not per-commit internals. what: - Add a new "Breaking changes" section covering the five package renames, the Sphinx 8.1 floor bump, and the gp-sphinx-* CSS namespace unification. - Append three bullets to the existing "Features" section: the three-tier design system restructuring, the new sphinx-ux-autodoc-layout package, and the new sphinx-autodoc-typehints-gp package.
1 parent 91acf53 commit d7d0f4c

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CHANGES

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ $ uv add gp-sphinx --prerelease allow
1818

1919
<!-- To maintainers and contributors: Please add notes for the forthcoming version below -->
2020

21+
### Breaking changes
22+
23+
- Package renames: `sphinx-argparse-neo` → `sphinx-autodoc-argparse`,
24+
`sphinx-gptheme` → `sphinx-gp-theme`, `sphinx-autodoc-badges` →
25+
`sphinx-ux-badges`, `sphinx-autodoc-layout` → `sphinx-ux-autodoc-layout`,
26+
`sphinx-typehints-gp` → `sphinx-autodoc-typehints-gp` (#18)
27+
- Sphinx floor bumped to 8.1 across the workspace (#18)
28+
- CSS classes and custom properties unified under a single `gp-sphinx-*`
29+
BEM namespace (retires the per-package `sab-`, `smf-`, `spf-`, `api-`,
30+
`gas-`, `gal-` prefixes and collapses their duplicate palettes) (#18)
31+
2132
### Features
2233

2334
- `sphinx-autodoc-fastmcp`: new Sphinx extension for FastMCP tool docs (card-style
@@ -36,6 +47,15 @@ $ uv add gp-sphinx --prerelease allow
3647
- `sphinx-autodoc-pytest-fixtures`: Fixture tables now resolve `TypeAlias`
3748
return annotations — alias names are preserved and linked rather than
3849
expanding to the underlying union or generic type (#9)
50+
- Integrated autodoc design system: twelve workspace packages in three
51+
tiers — shared infrastructure, domain autodocumenters, theme/coordinator —
52+
sharing one badge palette, one layout pipeline, and one typehint
53+
renderer (#18)
54+
- New `sphinx-ux-autodoc-layout` package — componentized autodoc output
55+
with card containers, parameter folding, and managed signatures (#18)
56+
- New `sphinx-autodoc-typehints-gp` package — single-package replacement
57+
for `sphinx-autodoc-typehints` + `sphinx.ext.napoleon`; resolves
58+
annotations statically at build time with no monkey-patching (#18)
3959

4060
### Bug fixes
4161

0 commit comments

Comments
 (0)