Skip to content

Commit 75226d3

Browse files
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

File tree

docs/cli/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
:gutter: 2 2 3 3
77

88
:::{grid-item-card} g
9-
:link: #command
10-
:link-type: url
9+
:link: cli-main
10+
:link-type: ref
1111
Proxy to your repo's VCS command.
1212
:::
1313

1414
:::{grid-item-card} Supported VCS
15-
:link: #supported-vcs
16-
:link-type: url
15+
:link: cli-supported-vcs
16+
:link-type: ref
1717
git, svn, and hg detection.
1818
:::
1919

@@ -65,6 +65,8 @@ $ g log --oneline -10
6565
$ g diff HEAD~1
6666
```
6767

68+
(cli-supported-vcs)=
69+
6870
## Supported VCS
6971

7072
| Directory marker | VCS command |

0 commit comments

Comments
 (0)