docs: Port CLI documentation improvements from tmuxp#1010 #502
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #502 +/- ##
=======================================
Coverage 80.52% 80.52%
=======================================
Files 16 16
Lines 2192 2192
Branches 454 454
=======================================
Hits 1765 1765
Misses 277 277
Partials 150 150 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Ports improvements from tmuxp#1010: - Linkable argument definitions with headerlinks (¶) - Updated argparse_exemplar and sphinx_argparse_neo modules
Tests for headerlink and linking improvements from tmuxp#1010
Biome-formatted CSS with consolidated light mode headerlink selectors
Replace tmuxp-specific examples with inline test module creation that works in any repository without external dependencies
- feat(docs): Render argparse metadata as semantic definition list Replace pipe-separated format with <dl>/<dt>/<dd> structure - style(css): Use var(--code-font-size) for all argparse elements Add font-size to inline roles, pre.argparse-usage, .argparse-argument-name Add new .argparse-argument-meta flexbox styles - fix(lexer): Include underscores in lowercase metavar patterns Change [a-z][-a-z0-9]* to [a-z][-a-z0-9_]* in 6 locations - test(lexer): Add underscore metavar regression test Add fixtures and test for socket_name, config_file patterns
Furo's "auto" theme follows system prefers-color-scheme. The meta tag dark styling only targeted explicit data-theme="dark", missing the auto-dark case where body:not([data-theme="light"]) applies.
The light mode override for headerlink colors used body:not([data-theme="dark"]) which incorrectly matches auto mode even when system is dark. Split into explicit light selector plus media query for auto + system light.
why: PR #502 lacked a user-facing changelog entry. what: - Document linkable argument definitions with permalink anchors - Note improved metadata styling and glob pattern handling - Mention multi-directive ID conflict resolution
Replace tmuxp-specific examples with generic "myapp" in doctests and comments. Also fix issue tracker link to point to vcspull repo.
Replace tmuxp examples in tests with generic "myapp" and fix docstring to reference vcspull instead of tmuxp.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Ports CLI documentation improvements from tmuxp#1010, enhancing the argparse directive rendering for better navigation and usability.
User-Facing Changes
--help,-v, etc.) now has a permalink anchor (¶) for direct linkingdjango-*no longer triggers RST warningsTechnical Changes
FORCE_COLORedge cases in usage textsocket_name)Files Changed
docs/_ext/sphinx_argparse_neo/modules (nodes, renderer, parser, utils)docs/_ext/argparse_exemplar.pydocs/_ext/argparse_lexer.pydocs/_static/css/argparse-highlight.csstests/docs/_ext/Reference