Commit 8ac714b
authored
docs(api) Visual improvements via gp-sphinx (#658)
Adopt the gp-sphinx Sphinx package stack for libtmux'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
+64
-21
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
43 | 48 | | |
44 | 49 | | |
45 | 50 | | |
| |||
| 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 | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
56 | | - | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
57 | 58 | | |
58 | 59 | | |
59 | 60 | | |
| |||
74 | 75 | | |
75 | 76 | | |
76 | 77 | | |
77 | | - | |
78 | | - | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
79 | 81 | | |
80 | 82 | | |
81 | 83 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments