You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
why: docs guidance requires first prose mentions to link useful
destinations and pages to frame reader intent before mechanics.
what:
- Link remaining VCS and tool/project first mentions
- Tighten project and code-style page voice
- Keep historical changelog entries navigable
g now consumes the published gp-sphinx package set instead of carrying repo-local Sphinx extensions, templates, custom CSS, and JavaScript. The shared stack provides the Furo-derived theme layer, argparse documentation support, font handling, API presentation helpers, and linkcode defaults in one place.
66
-
67
-
The API page now uses card-style autodoc signatures and badge styling from `sphinx-autodoc-api-style`; the CLI reference benefits from the argparse domain and duplicate-label fixes; and the later `gp-furo-theme` / `sphinx-vite-builder` consolidation moves theme assets into a wheel-backed Vite pipeline. Downstream effect: g stays aligned with the gp-libs docs platform while deleting thousands of lines of local documentation plumbing.
65
+
g now consumes the published gp-sphinx package set instead of carrying repo-local
66
+
[Sphinx](https://www.sphinx-doc.org/) extensions, templates, custom CSS, and
67
+
JavaScript. The shared stack provides the [Furo](https://pradyunsg.me/furo/)-derived
68
+
theme layer, argparse documentation support, font handling, API presentation
69
+
helpers, and linkcode defaults in one place.
70
+
71
+
The API page now uses card-style autodoc signatures and badge styling from
consolidation moves theme assets into a wheel-backed Vite pipeline. Downstream
77
+
effect: g stays aligned with the gp-libs docs platform while deleting thousands
78
+
of lines of local documentation plumbing.
68
79
69
80
### Fixes
70
81
@@ -84,7 +95,7 @@ matching reference material.
84
95
85
96
### Development
86
97
87
-
- Root `conftest.py` remains type-checked while the temporary docs-extension mypy path excludes only the extension-local `docs/_ext/conftest.py` case that caused duplicate module discovery (#46).
98
+
- Root `conftest.py` remains type-checked while the temporary docs-extension [mypy](https://mypy-lang.org/) path excludes only the extension-local `docs/_ext/conftest.py` case that caused duplicate module discovery (#46).
88
99
- The docs dependency pins track gp-sphinx through `0.0.1a17`, including the `exclude-newer` whitelist needed for the git-pull package family during coordinated pre-release work (#55).
89
100
90
101
## g 0.0.9 (2026-01-24)
@@ -95,11 +106,11 @@ g 0.0.9 hardens release and documentation publishing. The project no longer reli
95
106
96
107
#### PyPI Trusted Publisher release flow (#43)
97
108
98
-
Package publishing moved from stored API credentials to PyPI Trusted Publisher via GitHub Actions OIDC. The release workflow requests `id-token` and attestation permissions, publishes without embedding a PyPI token in repository secrets, and fixes the deprecated `skip_existing` input name along the way.
109
+
Package publishing moved from stored API credentials to PyPI Trusted Publisher via [GitHub Actions](https://docs.github.com/actions) OIDC. The release workflow requests `id-token` and attestation permissions, publishes without embedding a PyPI token in repository secrets, and fixes the deprecated `skip_existing` input name along the way.
99
110
100
111
#### OIDC-backed documentation deployment
101
112
102
-
Documentation deployment moved to AWS OIDC authentication and the AWS CLI. That keeps the docs pipeline aligned with the same short-lived-credential model used for package publishing.
113
+
Documentation deployment moved to AWS OIDC authentication and the [AWS CLI](https://aws.amazon.com/cli/). That keeps the docs pipeline aligned with the same short-lived-credential model used for package publishing.
103
114
104
115
### Development
105
116
@@ -114,7 +125,7 @@ g 0.0.8 updates the supported Python window for current runtimes. Python 3.9 sup
114
125
115
126
#### Minimum Python is now 3.10 (#41)
116
127
117
-
Python 3.9 reached end-of-life in October 2025, so g now requires Python 3.10 or newer. The package metadata, Trove classifiers, ruff target version, mypy configuration, test workflow, and lockfile were updated together so the declared support window matches CI.
128
+
Python 3.9 reached end-of-life in October 2025, so g now requires Python 3.10 or newer. The package metadata, Trove classifiers, [ruff](https://docs.astral.sh/ruff/) target version, mypy configuration, test workflow, and lockfile were updated together so the declared support window matches CI.
118
129
119
130
### What's new
120
131
@@ -146,7 +157,7 @@ The ruff target version and mypy `python_version` now match Python 3.9, and the
146
157
147
158
## g 0.0.6 (2024-11-26)
148
159
149
-
g 0.0.6 moves project management from Poetry to uv and switches the build backend to Hatchling. The release is a maintenance release, but it changes how contributors install, lock, build, and publish the project.
160
+
g 0.0.6 moves project management from [Poetry](https://python-poetry.org/) to uv and switches the build backend to [Hatchling](https://hatch.pypa.io/latest/). The release is a maintenance release, but it changes how contributors install, lock, build, and publish the project.
150
161
151
162
### Breaking changes
152
163
@@ -156,7 +167,7 @@ uv is now the package and project manager for g. Development setup uses `uv sync
156
167
157
168
#### Build backend moves from Poetry to Hatchling (#30)
158
169
159
-
The package build backend moved from Poetry to [Hatchling](https://hatch.pypa.io/latest/). This aligns g with the newer gp-libs project layout while keeping the package itself small.
170
+
The package build backend moved from Poetry to Hatchling. This aligns g with the newer gp-libs project layout while keeping the package itself small.
160
171
161
172
## g 0.0.5 (2024-06-08)
162
173
@@ -188,7 +199,7 @@ The lint configuration expanded to include additional ruff rule families, includ
188
199
189
200
#### Poetry and CI dependency maintenance
190
201
191
-
Poetry moved from `1.7.1` to `1.8.1`, and the CI helper actions were updated to remove warnings and keep CodeQL on GitHub's default configuration.
202
+
Poetry moved from `1.7.1` to `1.8.1`, and the CI helper actions were updated to remove warnings and keep [CodeQL](https://codeql.github.com/) on GitHub's default configuration.
192
203
193
204
## g 0.0.3 (2023-12-09)
194
205
@@ -214,7 +225,7 @@ Pytest configuration moved into `pyproject.toml`, and Poetry development depende
214
225
215
226
#### Ruff replaces the older formatting and lint stack (#11, #17)
216
227
217
-
Formatting, import sorting, and most linting moved to ruff, including `ruff format` in place of Black. This removed overlapping tooling while keeping fast local checks for a small CLI package.
228
+
Formatting, import sorting, and most linting moved to ruff, including `ruff format` in place of [Black](https://black.readthedocs.io/). This removed overlapping tooling while keeping fast local checks for a small CLI package.
218
229
219
230
#### CI and packaging maintenance (#8, #13)
220
231
@@ -228,9 +239,9 @@ g 0.0.2 moves the package into a standard `src/` layout and adopts the first gp-
228
239
229
240
#### gp-libs Sphinx helpers replace fragile local docs wiring (#6)
230
241
231
-
The changelog now renders with `linkify_issues`, and autodoc table-of-contents rendering uses the gp-libs Sphinx helper instead of the previous `sphinx-autoapi` path. The old `sphinx-autoapi` setup was intentionally removed because it was only carrying TOC behavior and had accumulated import-related workarounds.
242
+
The changelog now renders with [`linkify_issues`](https://gp-sphinx.git-pull.com/), and autodoc table-of-contents rendering uses the gp-libs Sphinx helper instead of the previous [`sphinx-autoapi`](https://sphinx-autoapi.readthedocs.io/) path. The old `sphinx-autoapi` setup was intentionally removed because it was only carrying TOC behavior and had accumulated import-related workarounds.
232
243
233
-
The docs also gained an internal API page backed by `sphinx.ext.autodoc`, which is now the source for API object rendering in the generated site.
244
+
The docs also gained an internal API page backed by [sphinx.ext.autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html), which is now the source for API object rendering in the generated site.
234
245
235
246
### Development
236
247
@@ -270,7 +281,7 @@ The first docs site used Sphinx, the Furo theme, and `sphinx-autobuild` for loca
270
281
271
282
### Development
272
283
273
-
Initial CI, Codecov, S3, and CloudFront deployment plumbing landed with the package scaffold.
284
+
Initial CI, Codecov, S3, and [CloudFront](https://aws.amazon.com/cloudfront/) deployment plumbing landed with the package scaffold.
0 commit comments