Skip to content

Commit 8ac714b

Browse files
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/CHANGES
2 parents fd2b607 + aae24d4 commit 8ac714b

File tree

4 files changed

+64
-21
lines changed

4 files changed

+64
-21
lines changed

CHANGES

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ $ uvx --from 'libtmux' --prerelease allow python
4040
_Notes on the upcoming release will go here._
4141
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->
4242

43+
### Documentation
44+
45+
- Visual improvements to API docs from [gp-sphinx](https://gp-sphinx.git-pull.com)-based Sphinx packages (#658)
46+
47+
4348
### What's new
4449

4550
#### pytest plugin: fixture reference documentation with autofixture directives (#656)

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/libtmux.svg",
3232
dark_logo="img/libtmux.svg",
33-
extra_extensions=["sphinx_autodoc_pytest_fixtures", "sphinx.ext.todo"],
33+
extra_extensions=[
34+
"sphinx_autodoc_api_style",
35+
"sphinx_autodoc_pytest_fixtures",
36+
"sphinx.ext.todo",
37+
],
3438
intersphinx_mapping={
3539
"python": ("https://docs.python.org/", None),
3640
"pytest": ("https://docs.pytest.org/en/stable/", None),

pyproject.toml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@ Changes = "https://github.com/tmux-python/libtmux/blob/master/CHANGES"
5252
[dependency-groups]
5353
dev = [
5454
# Docs (via gp-sphinx)
55-
"gp-sphinx==0.0.1a1",
56-
"sphinx-autodoc-pytest-fixtures==0.0.1a1",
55+
"gp-sphinx==0.0.1a7",
56+
"sphinx-autodoc-api-style==0.0.1a7",
57+
"sphinx-autodoc-pytest-fixtures==0.0.1a7",
5758
"sphinx-autobuild",
5859
"types-docutils",
5960
# Testing
@@ -74,8 +75,9 @@ dev = [
7475
]
7576

7677
docs = [
77-
"gp-sphinx==0.0.1a1",
78-
"sphinx-autodoc-pytest-fixtures==0.0.1a1",
78+
"gp-sphinx==0.0.1a7",
79+
"sphinx-autodoc-api-style==0.0.1a7",
80+
"sphinx-autodoc-pytest-fixtures==0.0.1a7",
7981
"sphinx-autobuild",
8082
]
8183
testing = [

uv.lock

Lines changed: 48 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)