Skip to content

Commit bbb319a

Browse files
authored
fix: use hyphenated page slugs in internal doc links (#796)
Update all internal MyST link references to use hyphens instead of underscores (e.g. packaging_simple → packaging-simple, gha_pure → gha-pure, gha_wheels → gha-wheels, data_files → data-files, repo_review → repo-review) to match the actual page filenames. Assisted-by: OpenCode:glm-5
1 parent 228add5 commit bbb319a

7 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/pages/guides/gha_pure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ reasons that a wheel is better than only providing an sdist:
2727
is going to go
2828
:::
2929

30-
[on the next page]: pages/guides/gha_wheels
30+
[on the next page]: pages/guides/gha-wheels
3131

3232
### Job setup
3333

docs/pages/guides/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ WebAssembly! All checks point to a linked badge in the guide.
4242
[style]: pages/guides/style
4343
[mypy]: pages/guides/mypy
4444
[docs]: pages/guides/docs
45-
[simple packaging]: pages/guides/packaging_simple
46-
[compiled packaging]: pages/guides/packaging_compiled
47-
[classic packaging]: pages/guides/packaging_classic
45+
[simple packaging]: pages/guides/packaging-simple
46+
[compiled packaging]: pages/guides/packaging-compiled
47+
[classic packaging]: pages/guides/packaging-classic
4848
[coverage]: pages/guides/coverage
49-
[gha_basic]: pages/guides/gha_basic
50-
[gha_pure]: pages/guides/gha_pure
51-
[gha_wheels]: pages/guides/gha_wheels
49+
[gha_basic]: pages/guides/gha-basic
50+
[gha_pure]: pages/guides/gha-pure
51+
[gha_wheels]: pages/guides/gha-wheels
5252
[pytest]: pages/guides/pytest
53-
[right in the guide]: pages/guides/repo_review
53+
[right in the guide]: pages/guides/repo-review
5454

5555
[cookiecutter]: https://cookiecutter.readthedocs.io
5656
[copier]: https://copier.readthedocs.io

docs/pages/guides/packaging_classic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ outlined as well.
1212
There are several popular packaging systems. This guide covers the old
1313
configuration style for [Setuptools][]. Unless you really need it, you should be
1414
using the modern style described in [Simple
15-
Packaging](pages/guides/packaging_simple). The modern style is
15+
Packaging](pages/guides/packaging-simple). The modern style is
1616
guided by Python Enhancement Proposals (PEPs), and is more stable than the
1717
setuptools-specific mechanisms that evolve over the years. This page is kept to
1818
help users with legacy code (and hopefully upgrade it).

docs/pages/guides/packaging_compiled.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The most exciting developments have been new native build backends:
4444

4545
:::{note}
4646
You should be familiar with [packing a pure Python
47-
project](pages/guides/packaging_compiled) - the metadata
47+
project](pages/guides/packaging-compiled) - the metadata
4848
configuration is the same.
4949
:::
5050
There are also classic setuptools plugins:
@@ -457,4 +457,4 @@ it is free-threaded. 3.13.5 was rushed out to fix it.
457457
[meson-python]: https://meson-python.readthedocs.io
458458
[setuptools-rust]: https://setuptools-rust.readthedocs.io/en/latest/
459459
[maturin]: https://www.maturin.rs
460-
[gha_wheels]: pages/guides/gha_wheels
460+
[gha_wheels]: pages/guides/gha-wheels

docs/pages/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,14 @@ with many updates. Improved support for compiled components supported in part
7575
by NSF grant [OAC-2209877][].
7676
:::
7777

78-
[simple]: pages/guides/packaging_simple
79-
[compiled]: pages/guides/packaging_compiled
78+
[simple]: pages/guides/packaging-simple
79+
[compiled]: pages/guides/packaging-compiled
8080
[style checking]: pages/guides/style
8181
[testing]: pages/guides/pytest
8282
[documentation]: pages/guides/docs
8383
[static typing]: pages/guides/mypy
84-
[ci]: pages/guides/gha_pure
85-
[right in the guide]: pages/guides/repo_review
84+
[ci]: pages/guides/gha-pure
85+
[right in the guide]: pages/guides/repo-review
8686

8787
[scientific-python/cookie]: https://github.com/scientific-python/cookie
8888
[repo-review]: https://repo-review.readthedocs.io

docs/pages/patterns/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you would like to use backport packages, see [Backports][].
1414

1515
If you are wondering about public API, see [Exports][].
1616

17-
[including data files]: pages/patterns/data_files
17+
[including data files]: pages/patterns/data-files
1818
[backports]: pages/patterns/backports
1919
[exports]: pages/patterns/exports
2020

docs/pages/tutorials/packaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@ In [1]: snell?
129129
For more about packaging, also see our [packaging guide][].
130130

131131
[version control with git]: https://swcarpentry.github.io/git-novice/
132-
[packaging guide]: pages/guides/packaging_simple
132+
[packaging guide]: pages/guides/packaging-simple

0 commit comments

Comments
 (0)