Skip to content

Commit cb4dee9

Browse files
authored
docs(api) Visual improvements via gp-sphinx (#53)
Adopt the gp-sphinx Sphinx package stack for g'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 a9696cf + dad637a commit cb4dee9

4 files changed

Lines changed: 63 additions & 21 deletions

File tree

CHANGES

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ $ uvx --from 'g' --prerelease allow g
3333
_Notes on upcoming releases will be added here_
3434
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->
3535

36+
### Documentation
37+
38+
- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#53)
39+
40+
3641
### CLI
3742

3843
- `g --version` and `g -V` now display g's version instead of being passed to

docs/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@
3030
source_branch="master",
3131
light_logo="img/g.svg",
3232
dark_logo="img/g-dark.svg",
33-
extra_extensions=["sphinx.ext.todo", "sphinx_argparse_neo.exemplar"],
33+
extra_extensions=[
34+
"sphinx_autodoc_api_style",
35+
"sphinx.ext.todo",
36+
"sphinx_argparse_neo.exemplar",
37+
],
3438
intersphinx_mapping={
3539
"py": ("https://docs.python.org/", None),
3640
"libvcs": ("http://libvcs.git-pull.com/", None),

pyproject.toml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@ dev = [
5959
# Docs
6060
"aafigure",
6161
"pillow",
62-
"gp-sphinx==0.0.1a1",
63-
"sphinx-argparse-neo==0.0.1a1",
62+
"gp-sphinx==0.0.1a7",
63+
"sphinx-argparse-neo==0.0.1a7",
64+
"sphinx-autodoc-api-style==0.0.1a7",
6465
"gp-libs",
6566
"sphinx-autobuild",
6667
# Testing
@@ -84,8 +85,9 @@ dev = [
8485
docs = [
8586
"aafigure",
8687
"pillow",
87-
"gp-sphinx==0.0.1a1",
88-
"sphinx-argparse-neo==0.0.1a1",
88+
"gp-sphinx==0.0.1a7",
89+
"sphinx-argparse-neo==0.0.1a7",
90+
"sphinx-autodoc-api-style==0.0.1a7",
8991
"gp-libs",
9092
"sphinx-autobuild",
9193
]

uv.lock

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

0 commit comments

Comments
 (0)