Skip to content

Commit f4d8811

Browse files
henryiiiCopilot
andcommitted
docs: fix tab sync keys to use tab names
Sync keys must match the tab label, not a group name, so that MyST can identify matching tabs across tab-sets. - docs.md: sphinx, mkdocs - gha_pure.md + gha_wheels.md: trusted-publishing, token - packaging_compiled.md: scikit-build-core, meson-python, maturin - coverage.md was already correct (coverage, pytest-cov) - Update AGENTS.md with correct sync key convention Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Assisted-by: copilot-cli:claude-sonnet-4.6
1 parent ef1a1f9 commit f4d8811

4 files changed

Lines changed: 19 additions & 19 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ The noxfile generates temporary projects for **all 9 backends** × **vcs on/off*
5959
- Custom CSS: `docs/assets/css/site.css` — only `.rr-btn` badge styling remains.
6060
- Docs pages in `docs/pages/` contain cog blocks that auto-generate config examples from the template.
6161
- The repo-review interactive page uses an `{iframe}` pointing to the WASM app at `https://scientific-python.github.io/repo-review/`.
62-
- Tab-sets use `:sync:` for cross-page tab synchronization: `coverage-tool`, `docs-framework`, `publish-method`, `compiled-backend`.
62+
- Tab-sets use `:sync: <tab-name>` for cross-page tab synchronization, where the sync key is the tab label itself (e.g., `sphinx`, `mkdocs`, `trusted-publishing`, `scikit-build-core`).

docs/pages/guides/gha_pure.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ recommended {rr}`GH105`:
128128

129129
::::{tab-set}
130130
:::{tab-item} Trusted Publishing (recommended)
131-
:sync: publish-method
131+
:sync: trusted-publishing
132132
{% raw %}
133133

134134
```yaml
@@ -167,7 +167,7 @@ We are also generating artifact attestations, which can allow users to verify
167167
that the artifacts were built on your actions.
168168
:::
169169
:::{tab-item} Token
170-
:sync: publish-method
170+
:sync: token
171171
{% raw %}
172172

173173
```yaml
@@ -203,7 +203,7 @@ interface:
203203

204204
::::{tab-set}
205205
:::{tab-item} Trusted Publishing (recommended)
206-
:sync: publish-method
206+
:sync: trusted-publishing
207207
{% raw %}
208208

209209
```yaml
@@ -256,7 +256,7 @@ jobs:
256256
{% endraw %}
257257
:::
258258
:::{tab-item} Token
259-
:sync: publish-method
259+
:sync: token
260260
{% raw %}
261261

262262
```yaml

docs/pages/guides/gha_wheels.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Trusted Publishing is more secure and recommended {rr}`GH105`:
165165

166166
::::{tab-set}
167167
:::{tab-item} Trusted Publishing (recommended)
168-
:sync: publish-method
168+
:sync: trusted-publishing
169169
{% raw %}
170170

171171
```yaml
@@ -206,7 +206,7 @@ We are also generating artifact attestations, which can allow users to verify
206206
that the artifacts were built on your actions.
207207
:::
208208
:::{tab-item} Token
209-
:sync: publish-method
209+
:sync: token
210210
{% raw %}
211211

212212
```yaml

docs/pages/guides/packaging_compiled.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ selects the backend:
7070

7171
::::{tab-set}
7272
:::{tab-item} Scikit-build-core
73-
:sync: compiled-backend
73+
:sync: scikit-build-core
7474
<!-- [[[cog
7575
with code_fence("toml"):
7676
print(skbuild_pyproject.get_source("build-system"))
@@ -85,7 +85,7 @@ build-backend = "scikit_build_core.build"
8585
<!-- [[[end]]] -->
8686
:::
8787
:::{tab-item} Meson-python
88-
:sync: compiled-backend
88+
:sync: meson-python
8989
<!-- [[[cog
9090
with code_fence("toml"):
9191
print(mesonpy_pyproject.get_source("build-system"))
@@ -100,7 +100,7 @@ build-backend = "mesonpy"
100100
<!-- [[[end]]] -->
101101
:::
102102
:::{tab-item} Maturin
103-
:sync: compiled-backend
103+
:sync: maturin
104104
<!-- [[[cog
105105
with code_fence("toml"):
106106
print(maturin_pyproject.get_source("build-system"))
@@ -126,7 +126,7 @@ options in `tool.*` settings.
126126

127127
::::{tab-set}
128128
:::{tab-item} Scikit-build-core
129-
:sync: compiled-backend
129+
:sync: scikit-build-core
130130
<!-- [[[cog
131131
with code_fence("toml"):
132132
print(skbuild_pyproject.get_source("tool.scikit-build"))
@@ -143,11 +143,11 @@ build-dir = "build/{wheel_tag}"
143143
These options are not required, but can improve your experience.
144144
:::
145145
:::{tab-item} Meson-python
146-
:sync: compiled-backend
146+
:sync: meson-python
147147
No `tool.meson-python` configuration required for this example.
148148
:::
149149
:::{tab-item} Maturin
150-
:sync: compiled-backend
150+
:sync: maturin
151151
<!-- [[[cog
152152
with code_fence("toml"):
153153
print(maturin_pyproject.get_source("tool.maturin"))
@@ -171,7 +171,7 @@ configuration here to follow the convention of the other tools here.
171171

172172
::::{tab-set}
173173
:::{tab-item} Scikit-build-core
174-
:sync: compiled-backend
174+
:sync: scikit-build-core
175175
Example `CMakeLists.txt` file (using pybind11, so include `pybind11` in
176176
`build-system.requires` too):
177177

@@ -198,7 +198,7 @@ files to your distributions; it also has a default ignore for common cache
198198
files, so you can get started without one, but it's recommended.
199199
:::
200200
:::{tab-item} Meson-python
201-
:sync: compiled-backend
201+
:sync: meson-python
202202
Example `meson.build` file (using pybind11, so include `pybind11` in
203203
`build-system.requires` too):
204204

@@ -239,7 +239,7 @@ project, you will likely be doing this, but when trying out a build backend you
239239
might not think to set up a git repo to build it.
240240
:::
241241
:::{tab-item} Maturin
242-
:sync: compiled-backend
242+
:sync: maturin
243243
Example `Cargo.toml` file:
244244

245245
<!-- [[[cog
@@ -281,7 +281,7 @@ name you wish, though, or even make your compiled extension a top level module.
281281

282282
::::{tab-set}
283283
:::{tab-item} Scikit-build-core
284-
:sync: compiled-backend
284+
:sync: scikit-build-core
285285
Example `src/main.cpp` file:
286286

287287
<!-- [[[cog
@@ -322,7 +322,7 @@ PYBIND11_MODULE(_core, m) {
322322
<!-- [[[end]]] -->
323323
:::
324324
:::{tab-item} Meson-python
325-
:sync: compiled-backend
325+
:sync: meson-python
326326
Example `src/main.cpp` file:
327327
328328
<!-- [[[cog
@@ -363,7 +363,7 @@ PYBIND11_MODULE(_core, m) {
363363
<!-- [[[end]]] -->
364364
:::
365365
:::{tab-item} Maturin
366-
:sync: compiled-backend
366+
:sync: maturin
367367
Example `src/lib.rs` file:
368368

369369
<!-- [[[cog

0 commit comments

Comments
 (0)