Commit 4e51b18
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/CHANGES4 files changed
Lines changed: 62 additions & 22 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
40 | 44 | | |
41 | 45 | | |
42 | 46 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | | - | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
39 | 42 | | |
40 | 43 | | |
41 | 44 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
74 | | - | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
75 | 76 | | |
76 | 77 | | |
77 | 78 | | |
| |||
98 | 99 | | |
99 | 100 | | |
100 | 101 | | |
101 | | - | |
102 | | - | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
103 | 105 | | |
104 | 106 | | |
105 | 107 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments