Skip to content

Commit c534812

Browse files
committed
docs(style): link remaining docs refs
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
1 parent bb040bb commit c534812

7 files changed

Lines changed: 50 additions & 24 deletions

File tree

CHANGES

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,20 @@ The frontend gained self-hosted IBM Plex fonts, fallback metrics to avoid text r
6262

6363
#### Shared gp-sphinx documentation stack (#52, #53, #54, #55)
6464

65-
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
72+
[`sphinx-autodoc-api-style`](https://pypi.org/project/sphinx-autodoc-api-style/);
73+
the CLI reference benefits from the argparse domain and duplicate-label fixes;
74+
and the later [`gp-furo-theme`](https://pypi.org/project/gp-furo-theme/) /
75+
[`sphinx-vite-builder`](https://pypi.org/project/sphinx-vite-builder/)
76+
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.
6879

6980
### Fixes
7081

@@ -84,7 +95,7 @@ matching reference material.
8495

8596
### Development
8697

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).
8899
- 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).
89100

90101
## 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
95106

96107
#### PyPI Trusted Publisher release flow (#43)
97108

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.
99110

100111
#### OIDC-backed documentation deployment
101112

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.
103114

104115
### Development
105116

@@ -114,7 +125,7 @@ g 0.0.8 updates the supported Python window for current runtimes. Python 3.9 sup
114125

115126
#### Minimum Python is now 3.10 (#41)
116127

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.
118129

119130
### What's new
120131

@@ -146,7 +157,7 @@ The ruff target version and mypy `python_version` now match Python 3.9, and the
146157

147158
## g 0.0.6 (2024-11-26)
148159

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.
150161

151162
### Breaking changes
152163

@@ -156,7 +167,7 @@ uv is now the package and project manager for g. Development setup uses `uv sync
156167

157168
#### Build backend moves from Poetry to Hatchling (#30)
158169

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.
160171

161172
## g 0.0.5 (2024-06-08)
162173

@@ -188,7 +199,7 @@ The lint configuration expanded to include additional ruff rule families, includ
188199

189200
#### Poetry and CI dependency maintenance
190201

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.
192203

193204
## g 0.0.3 (2023-12-09)
194205

@@ -214,7 +225,7 @@ Pytest configuration moved into `pyproject.toml`, and Poetry development depende
214225

215226
#### Ruff replaces the older formatting and lint stack (#11, #17)
216227

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.
218229

219230
#### CI and packaging maintenance (#8, #13)
220231

@@ -228,9 +239,9 @@ g 0.0.2 moves the package into a standard `src/` layout and adopts the first gp-
228239

229240
#### gp-libs Sphinx helpers replace fragile local docs wiring (#6)
230241

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.
232243

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.
234245

235246
### Development
236247

@@ -270,7 +281,7 @@ The first docs site used Sphinx, the Furo theme, and `sphinx-autobuild` for loca
270281

271282
### Development
272283

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.
274285

275286
<!---
276287
.. vim: set filetype=markdown:

docs/cli/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,13 @@ Proxy to your repo's VCS command.
1414
:::{grid-item-card} Supported VCS
1515
:link: cli-supported-vcs
1616
:link-type: ref
17-
git, svn, and hg detection.
17+
Repository detection.
1818
:::
1919

2020
::::
2121

2222
g is a minimal CLI wrapper that proxies to your current directory's VCS command.
23+
It detects [Git], [Subversion], and [Mercurial] repositories.
2324

2425
## How it works
2526

@@ -95,3 +96,7 @@ $ g diff HEAD~1
9596
| `.git` | `git` |
9697
| `.svn` | `svn` |
9798
| `.hg` | `hg` |
99+
100+
[Git]: https://git-scm.com/
101+
[Mercurial]: https://www.mercurial-scm.org/
102+
[Subversion]: https://subversion.apache.org/

docs/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
# g
44

5-
A tiny CLI wrapper for git, svn, and hg -- auto-detects your repo type and proxies commands.
5+
A tiny CLI wrapper for [Git], [Subversion], and [Mercurial] -- auto-detects
6+
your repo type and proxies commands.
67

78
::::{grid} 1 2 3 3
89
:gutter: 2 2 3 3
@@ -47,6 +48,10 @@ $ g status
4748

4849
Inside a git repo this runs `git status`; inside an svn checkout it runs `svn status`; inside a mercurial repo it runs `hg status`.
4950

51+
[Git]: https://git-scm.com/
52+
[Mercurial]: https://www.mercurial-scm.org/
53+
[Subversion]: https://subversion.apache.org/
54+
5055
```{toctree}
5156
:hidden:
5257

docs/project/code-style.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ expects.
55

66
## Formatting
77

8-
g uses [ruff](https://github.com/astral-sh/ruff) for linting and formatting.
8+
Run [ruff](https://github.com/astral-sh/ruff) before committing Python changes.
99

1010
```console
1111
$ uv run ruff check . --fix
@@ -17,7 +17,7 @@ $ uv run ruff format .
1717

1818
## Type Checking
1919

20-
[mypy](https://mypy-lang.org/) is used for static type checking.
20+
Run [mypy](https://mypy-lang.org/) for static type checking.
2121

2222
```console
2323
$ uv run mypy .

docs/project/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Rebuild docs and run server via one terminal: `make dev_docs` (requires above, a
7171

7272
## Formatting / Linting
7373

74-
### ruff
74+
### Linting and formatting
7575

7676
The project uses [ruff] to handle formatting, sorting imports and linting.
7777

@@ -125,7 +125,7 @@ $ ruff check . --fix
125125
126126
````
127127

128-
#### ruff format
128+
#### Code formatting
129129

130130
Use [ruff format] for formatting.
131131

@@ -153,7 +153,7 @@ $ make ruff_format
153153
154154
````
155155

156-
### mypy
156+
### Type checking
157157

158158
Use [mypy] for static type checking.
159159

docs/project/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
# Project
44

5-
Information for contributors and maintainers.
5+
Use this section when you want to change g itself: set up a checkout, run the
6+
project checks, or prepare a release.
67

78
::::{grid} 1 1 2 2
89
:gutter: 2 2 3 3
@@ -16,7 +17,7 @@ Development setup, running tests, submitting PRs.
1617
:::{grid-item-card} Code Style
1718
:link: code-style
1819
:link-type: doc
19-
Ruff, mypy, and import conventions.
20+
Formatting, type checks, and import conventions.
2021
:::
2122

2223
::::

docs/quickstart.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
## Installation
66

7-
Install g once, then run `g` where you already run `git`, `svn`, or `hg`.
7+
Install g once, then run `g` where you already run [Git], [Subversion], or
8+
[Mercurial].
89
Use one of these commands for the latest official version.
910

1011
```console
@@ -122,3 +123,6 @@ For unreleased trunk builds, expect breakage:
122123
[uv]: https://docs.astral.sh/uv/
123124
[uv-tools]: https://docs.astral.sh/uv/concepts/tools/
124125
[uvx]: https://docs.astral.sh/uv/guides/tools/
126+
[Git]: https://git-scm.com/
127+
[Mercurial]: https://www.mercurial-scm.org/
128+
[Subversion]: https://subversion.apache.org/

0 commit comments

Comments
 (0)