Skip to content

feat(docs): Add linkable arguments with headerlinks to argparse directive #1010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tony merged 21 commits into from
Jan 25, 2026
Merged

feat(docs): Add linkable arguments with headerlinks to argparse directive #1010

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
7eac4cc
feat(nodes): Add linkable arguments with wrapper and headerlink
tony Jan 25, 2026
5c7f1d0
feat(renderer): Thread id_prefix to argument nodes
tony Jan 25, 2026
4a942cd
style(css): Add argument wrapper and headerlink styles
tony Jan 25, 2026
c9ec5ac
test(nodes): Add tests for ID generation and HTML rendering
tony Jan 25, 2026
6be7fcc
style(css): Add light mode overrides for argument backgrounds
tony Jan 25, 2026
40eddab
style(css): Add width fit-content to argument wrapper
tony Jan 25, 2026
0116210
style(css): Refine argument name styling with monokai background
tony Jan 25, 2026
e7706ef
style(css): Add light mode headerlink hover color
tony Jan 25, 2026
3eae0dd
style(css): Style default values as inline code in argument meta
tony Jan 25, 2026
9a3feb6
style(css): Use custom --argparse-code-background variable
tony Jan 25, 2026
fe4a03d
style(css): Adjust argument styling and fix mypy warnings
tony Jan 25, 2026
24a86d3
style(css): Show headerlink when argument is targeted via URL fragment
tony Jan 25, 2026
358b3e8
style(css): Consolidate duplicate selectors and use CSS variable
tony Jan 25, 2026
d89198d
style(css): Position headerlink outside argument name element
tony Jan 25, 2026
f5c8591
style(css): Remove unnecessary width: fit-content from wrapper
tony Jan 25, 2026
4a7cbb0
style(css): Reduce default value badge size with smaller font and pad…
tony Jan 25, 2026
c97be8a
style(css): Remove italic from default value badge
tony Jan 25, 2026
1802705
style(css): Consolidate .cli-command and .cli-choice green color
tony Jan 25, 2026
2133a0d
style(css): Consolidate light mode headerlink selectors with nesting
tony Jan 25, 2026
643e215
style(css): Format with biome (tabs, lowercase hex, leading zeros)
tony Jan 25, 2026
4f22db0
docs(CHANGES): Add user-focused notes for linkable CLI arguments (#1010)
tony Jan 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
style(css): Adjust argument styling and fix mypy warnings 
- Increase .argparse-argument-name padding to .485rem .875rem
- Add .argparse-argument-help with padding-block-start for spacing
- Remove unused type: ignore comments in test_nodes.py
  • Loading branch information
@tony
tony committed Jan 25, 2026
commit fe4a03d3b7e16104a1d5a31b89e2c5781b6d683d
10 changes: 9 additions & 1 deletion docs/_static/css/argparse-highlight.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ pre.argparse-usage {
.argparse-argument-name {
background: var(--argparse-code-background);
border-radius: .2rem;
padding: .325rem .6rem;
padding: .485rem .875rem;
font-family: var(--font-stack--monospace);
width: fit-content;
}
Expand Down Expand Up @@ -353,3 +353,11 @@ body:not([data-theme="dark"]) .argparse-argument-name .headerlink:hover:not(:vis
color: #E5C07B;
font-style: italic;
}

/*
* Help text description
* Adds spacing above for visual separation from argument name.
*/
.argparse-argument-help {
padding-block-start: 0.5rem;
}
4 changes: 2 additions & 2 deletions tests/docs/_ext/sphinx_argparse_neo/test_nodes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,8 @@ def render_argument_to_html(
node["id_prefix"] = id_prefix

translator = MockTranslator()
visit_argparse_argument_html(translator, node) # type: ignore[arg-type]
depart_argparse_argument_html(translator, node) # type: ignore[arg-type]
visit_argparse_argument_html(translator, node)
depart_argparse_argument_html(translator, node)

return "".join(translator.body)

Expand Down