Commit 75226d3
committed
docs(fix[cli]): ref-link grid-item-cards instead of url-fragment anchors
why: The two grid-item-card blocks in the CLI Reference page used
URL-fragment 🔗 options (`#command`, `#supported-vcs`) with
:link-type: url. MyST-parser treats `#` inside a directive's
options block as a YAML-style comment, so the fragment was
stripped and 🔗 was left with an empty value. That produced
five cascading `sphinx-build -W` warnings: two
[myst.directive_comments], two [myst.directive_option] ("Invalid
option value for 'link': None"), and one [design.grid] ("All
children of a 'grid-row' should be 'grid-item'") because the
half-parsed card nodes weren't valid grid-items for sphinx-design
0.7's stricter row-children check.
what:
- Switch both grid-item-cards to :link-type: ref with bare label
targets (🔗 cli-main, 🔗 cli-supported-vcs). No `#`
in the options block -> no MyST comment interpretation -> the
cards parse cleanly as grid-items and the cascading
design.grid warning goes away.
- Add a (cli-supported-vcs)= label before the `## Supported VCS`
heading so the new ref target resolves. cli-main already
existed above `## Command`.
- Does not address the remaining "Duplicate ID: usage" critical
from the manual `## Usage` heading colliding with the
.. argparse:: directive's built-in Usage section — that lands
in a separate commit for reviewability.1 parent 2c8e232 commit 75226d3
1 file changed
Lines changed: 6 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
10 | | - | |
| 9 | + | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
16 | | - | |
| 15 | + | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
| 68 | + | |
| 69 | + | |
68 | 70 | | |
69 | 71 | | |
70 | 72 | | |
| |||
0 commit comments