Commit 6264eef
committed
sphinx-autodoc-argparse(docs[domain]): document :argparse:* roles and indices
why: The argparse domain is live (E1-E5) and sits in Tier 2 (E6),
but the package page has no user-facing documentation on how to
use the new xref roles or the two auto-generated indices. Add a
"Cross-reference roles" section covering the full role vocabulary,
the target-syntax rules (whitespace-joined vs bare), and the
intersphinx-compat contract — so readers know `:argparse:option:`
is now the idiomatic form without losing `:option:` access for
intersphinx consumers.
what:
- Add a "Cross-reference roles" section to
docs/packages/sphinx-autodoc-argparse.md after "Inline roles"
with:
* A four-row table listing :argparse:program: /
:argparse:option: / :argparse:subcommand: /
:argparse:positional: with concrete example targets.
* A short paragraph on target-syntax rules (whitespace-join
splits into a (program, name) tuple key; bare form resolves
when there's one match).
* "Auto-generated indices" subsection naming
argparse-programsindex and argparse-optionsindex with
:ref: link examples.
* "Intersphinx compatibility" note clarifying that
:option: / std:cmdoption continues to resolve and appear in
objects.inv for external consumers.1 parent e24c9fd commit 6264eef
1 file changed
+37
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
54 | 91 | | |
55 | 92 | | |
56 | 93 | | |
| |||
0 commit comments