Commit 681ba52
committed
docs(fix[cli]): rename manual "Usage" heading to avoid argparse Id collision
why: The CLI Reference page has both a manual `## Usage` MyST
heading (showing `g <cmd>` -> underlying VCS invocation
equivalences) and a `.. argparse::` directive block that emits
its own auto-generated "Usage" section (showing the synopsis
line). Both produced the docutils anchor id `usage` on the same
page, tripping a `CRITICAL: Duplicate ID: "usage" [docutils]`
warning and failing `sphinx-build -W`.
what:
- Rename the manual section from `## Usage` to
`## Usage examples`. The new slug `usage-examples` no longer
collides with argparse's `usage`, and the heading describes
the actual content better (it's a collection of equivalence
examples, not a synopsis).
- No content changes; only the heading text.
- With this + the prior ref-link commit, `uv run sphinx-build -W
-b dirhtml docs docs/_build/html` now passes cleanly (was: 6
warnings treated as errors).1 parent 75226d3 commit 681ba52
1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
0 commit comments