Commit cb4dee9
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/CHANGES4 files changed
Lines changed: 63 additions & 21 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
36 | 41 | | |
37 | 42 | | |
38 | 43 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
34 | 38 | | |
35 | 39 | | |
36 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | | - | |
63 | | - | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
64 | 65 | | |
65 | 66 | | |
66 | 67 | | |
| |||
84 | 85 | | |
85 | 86 | | |
86 | 87 | | |
87 | | - | |
88 | | - | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
89 | 91 | | |
90 | 92 | | |
91 | 93 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments