docs(feat[api-style]): Visual improvements to API docs via gp-sphinx#658
Merged
docs(feat[api-style]): Visual improvements to API docs via gp-sphinx#658
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #658 +/- ##
==========================================
- Coverage 46.63% 46.55% -0.09%
==========================================
Files 22 22
Lines 2363 2363
Branches 389 389
==========================================
- Hits 1102 1100 -2
- Misses 1093 1094 +1
- Partials 168 169 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
why: The sphinx-autodoc-api-style extension adds type and modifier badges to autodoc entries, matching the visual language of sphinx-autodoc-pytest-fixtures. what: - Add sphinx_autodoc_api_style to extra_extensions in docs/conf.py
…to 0.0.1a5 why: Wire in the standalone api-style package next to gp-sphinx; align dev/docs pins and the lockfile with the latest gp-sphinx workspace releases. what: - Add sphinx-autodoc-api-style to dev and docs groups - Add uv.sources path overrides for gp-sphinx, sphinx-autodoc-api-style, and sphinx-autodoc-pytest-fixtures - Pin gp-sphinx, sphinx-autodoc-api-style, and sphinx-autodoc-pytest-fixtures to 0.0.1a5; regenerate uv.lock
why: Align dev docs dependencies with gp-sphinx 0.0.1a6 on PyPI. what: - Bump gp-sphinx ecosystem pins in pyproject.toml - Regenerate uv.lock
why: Pick up the sphinx-argparse-neo multi-page duplicate-label scoping fix landed in gp-sphinx PR #16 so docs builds on this branch emit fewer duplicate label warnings. what: - Bump gp-sphinx and sibling package pins from 0.0.1a6 to 0.0.1a7 - Regenerate uv.lock
why: Capture the api-styling migration to the gp-sphinx package stack in the unreleased notes. what: - Add a Documentation bullet under libtmux (unreleased) linking to the project PR
tony
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
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.1a7pre-release.What's new
sphinx-autodoc-api-style— card layouts, badges, MyST roles for Python objectssphinx-autodoc-badges— consistent XS/SM/LG/XL size variants with WCAG-AA contrastsphinx-argparse-neo— CLI doc builds no longer emitduplicate labelwarnings (gp-sphinx#16)sphinx-fonts— IBM Plex Sans and Mono at full weight range, zero-CLS loadingVerification
uv run ruff check . --fix --show-fixesuv run ruff format .uv run mypyuv run py.test --reruns 0 -vvvjust build-docsAll pass on the branch tip. See gp-sphinx 0.0.1 release notes for the full list of changes covering
0.0.1a1..0.0.1a7.