Skip to content

Commit d02ab87

Browse files
authored
docs(api) Visual improvements via gp-sphinx (#67)
Adopt the gp-sphinx Sphinx package stack for gp-libs's API documentation. The net visual effect is card-style autodoc signatures with safety and scope badges, MyST cross-reference roles for Python objects, scoped section names in multi-page CLI docs, and polished IBM Plex typography — all landing together from the gp-sphinx 0.0.1a7 pre-release. - **API-style autodoc layout** via sphinx-autodoc-api-style — card layouts, badges, MyST roles for Python objects - **Shared badge layer** via sphinx-autodoc-badges — consistent XS/SM/LG/XL size variants with WCAG-AA contrast - **Multi-page argparse scoping** via sphinx-argparse-neo — CLI doc builds no longer emit duplicate-label warnings (git-pull/gp-sphinx#16) - **Font polish** via sphinx-fonts — IBM Plex Sans and Mono at full weight range, zero-CLS loading See gp-sphinx 0.0.1a7 release notes for the full list of changes covering 0.0.1a1..0.0.1a7: https://github.com/git-pull/gp-sphinx/blob/v0.0.1a7/CHANGES
2 parents ce477ff + 867ecee commit d02ab87

File tree

4 files changed

+48
-13
lines changed

4 files changed

+48
-13
lines changed

CHANGES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ $ uvx --from 'gp-libs' --prerelease allow gp-libs
4141
### Documentation
4242

4343
- Migrate docs deployment to AWS OIDC authentication and AWS CLI
44+
- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#67)
4445

4546
## gp-libs 0.0.17 (2025-12-07)
4647

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
source_branch="master",
3030
light_logo="img/icons/logo.svg",
3131
dark_logo="img/icons/logo-dark.svg",
32+
extra_extensions=["sphinx_autodoc_api_style"],
3233
intersphinx_mapping={
3334
"py": ("https://docs.python.org/", None),
3435
"pytest": ("https://docs.pytest.org/en/stable/", None),

pyproject.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ Changes = "https://github.com/git-pull/gp-libs/blob/master/CHANGES"
4848
[dependency-groups]
4949
dev = [
5050
# Docs
51-
"gp-sphinx==0.0.1a1",
51+
"gp-sphinx==0.0.1a7",
52+
"sphinx-autodoc-api-style==0.0.1a7",
5253
"gp-libs",
5354
"sphinx-autobuild",
5455
# Testing
@@ -69,7 +70,8 @@ dev = [
6970
]
7071

7172
docs = [
72-
"gp-sphinx==0.0.1a1",
73+
"gp-sphinx==0.0.1a7",
74+
"sphinx-autodoc-api-style==0.0.1a7",
7375
"gp-libs",
7476
"sphinx-autobuild",
7577
]

uv.lock

Lines changed: 42 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)