Skip to content

Commit 4e51b18

Browse files
authored
docs(api) Visual improvements via gp-sphinx (#542)
Adopt the gp-sphinx Sphinx package stack for vcspull'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 e498d50 + 3d66f56 commit 4e51b18

4 files changed

Lines changed: 62 additions & 22 deletions

File tree

CHANGES

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ $ uvx --from 'vcspull' --prerelease allow vcspull
3737
_Notes on upcoming releases will be added here_
3838
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->
3939

40+
### Documentation
41+
42+
- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#542)
43+
4044
## vcspull v1.58.1 (2026-03-29)
4145

4246
### Bug fixes

docs/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@
3535
source_branch="master",
3636
light_logo="img/vcspull.svg",
3737
dark_logo="img/vcspull-dark.svg",
38-
extra_extensions=["sphinx_argparse_neo.exemplar"],
38+
extra_extensions=[
39+
"sphinx_autodoc_api_style",
40+
"sphinx_argparse_neo.exemplar",
41+
],
3942
intersphinx_mapping={
4043
"py": ("https://docs.python.org/", None),
4144
"libvcs": ("https://libvcs.git-pull.com/", None),

pyproject.toml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@ vcspull = "vcspull:cli.cli"
7070
[dependency-groups]
7171
dev = [
7272
# Docs
73-
"gp-sphinx==0.0.1a1",
74-
"sphinx-argparse-neo==0.0.1a1",
73+
"gp-sphinx==0.0.1a7",
74+
"sphinx-argparse-neo==0.0.1a7",
75+
"sphinx-autodoc-api-style==0.0.1a7",
7576
"gp-libs",
7677
"sphinx-autobuild",
7778
# Testing
@@ -98,8 +99,9 @@ dev = [
9899
]
99100

100101
docs = [
101-
"gp-sphinx==0.0.1a1",
102-
"sphinx-argparse-neo==0.0.1a1",
102+
"gp-sphinx==0.0.1a7",
103+
"sphinx-argparse-neo==0.0.1a7",
104+
"sphinx-autodoc-api-style==0.0.1a7",
103105
"gp-libs",
104106
"sphinx-autobuild",
105107
]

uv.lock

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

0 commit comments

Comments
 (0)