From d8f8caa5ed094f80525952b127b7ff5ba2d270ca Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 9 Jun 2026 00:30:41 -0400 Subject: [PATCH] fix: use hyphenated page slugs in internal doc links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- docs/pages/guides/gha_pure.md | 2 +- docs/pages/guides/index.md | 14 +++++++------- docs/pages/guides/packaging_classic.md | 2 +- docs/pages/guides/packaging_compiled.md | 4 ++-- docs/pages/index.md | 8 ++++---- docs/pages/patterns/index.md | 2 +- docs/pages/tutorials/packaging.md | 2 +- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/pages/guides/gha_pure.md b/docs/pages/guides/gha_pure.md index d80a857d..11a6a023 100644 --- a/docs/pages/guides/gha_pure.md +++ b/docs/pages/guides/gha_pure.md @@ -27,7 +27,7 @@ reasons that a wheel is better than only providing an sdist: is going to go ::: -[on the next page]: pages/guides/gha_wheels +[on the next page]: pages/guides/gha-wheels ### Job setup diff --git a/docs/pages/guides/index.md b/docs/pages/guides/index.md index b103c780..dbbe9ed6 100644 --- a/docs/pages/guides/index.md +++ b/docs/pages/guides/index.md @@ -42,15 +42,15 @@ WebAssembly! All checks point to a linked badge in the guide. [style]: pages/guides/style [mypy]: pages/guides/mypy [docs]: pages/guides/docs -[simple packaging]: pages/guides/packaging_simple -[compiled packaging]: pages/guides/packaging_compiled -[classic packaging]: pages/guides/packaging_classic +[simple packaging]: pages/guides/packaging-simple +[compiled packaging]: pages/guides/packaging-compiled +[classic packaging]: pages/guides/packaging-classic [coverage]: pages/guides/coverage -[gha_basic]: pages/guides/gha_basic -[gha_pure]: pages/guides/gha_pure -[gha_wheels]: pages/guides/gha_wheels +[gha_basic]: pages/guides/gha-basic +[gha_pure]: pages/guides/gha-pure +[gha_wheels]: pages/guides/gha-wheels [pytest]: pages/guides/pytest -[right in the guide]: pages/guides/repo_review +[right in the guide]: pages/guides/repo-review [cookiecutter]: https://cookiecutter.readthedocs.io [copier]: https://copier.readthedocs.io diff --git a/docs/pages/guides/packaging_classic.md b/docs/pages/guides/packaging_classic.md index c32b361d..f28bc8f9 100644 --- a/docs/pages/guides/packaging_classic.md +++ b/docs/pages/guides/packaging_classic.md @@ -12,7 +12,7 @@ outlined as well. There are several popular packaging systems. This guide covers the old configuration style for [Setuptools][]. Unless you really need it, you should be using the modern style described in [Simple -Packaging](pages/guides/packaging_simple). The modern style is +Packaging](pages/guides/packaging-simple). The modern style is guided by Python Enhancement Proposals (PEPs), and is more stable than the setuptools-specific mechanisms that evolve over the years. This page is kept to help users with legacy code (and hopefully upgrade it). diff --git a/docs/pages/guides/packaging_compiled.md b/docs/pages/guides/packaging_compiled.md index bfdc6c65..4378f8c0 100644 --- a/docs/pages/guides/packaging_compiled.md +++ b/docs/pages/guides/packaging_compiled.md @@ -44,7 +44,7 @@ The most exciting developments have been new native build backends: :::{note} You should be familiar with [packing a pure Python -project](pages/guides/packaging_compiled) - the metadata +project](pages/guides/packaging-compiled) - the metadata configuration is the same. ::: There are also classic setuptools plugins: @@ -457,4 +457,4 @@ it is free-threaded. 3.13.5 was rushed out to fix it. [meson-python]: https://meson-python.readthedocs.io [setuptools-rust]: https://setuptools-rust.readthedocs.io/en/latest/ [maturin]: https://www.maturin.rs -[gha_wheels]: pages/guides/gha_wheels +[gha_wheels]: pages/guides/gha-wheels diff --git a/docs/pages/index.md b/docs/pages/index.md index ad562dcb..f14ea57b 100644 --- a/docs/pages/index.md +++ b/docs/pages/index.md @@ -75,14 +75,14 @@ with many updates. Improved support for compiled components supported in part by NSF grant [OAC-2209877][]. ::: -[simple]: pages/guides/packaging_simple -[compiled]: pages/guides/packaging_compiled +[simple]: pages/guides/packaging-simple +[compiled]: pages/guides/packaging-compiled [style checking]: pages/guides/style [testing]: pages/guides/pytest [documentation]: pages/guides/docs [static typing]: pages/guides/mypy -[ci]: pages/guides/gha_pure -[right in the guide]: pages/guides/repo_review +[ci]: pages/guides/gha-pure +[right in the guide]: pages/guides/repo-review [scientific-python/cookie]: https://github.com/scientific-python/cookie [repo-review]: https://repo-review.readthedocs.io diff --git a/docs/pages/patterns/index.md b/docs/pages/patterns/index.md index bb6f735e..bd710616 100644 --- a/docs/pages/patterns/index.md +++ b/docs/pages/patterns/index.md @@ -14,7 +14,7 @@ If you would like to use backport packages, see [Backports][]. If you are wondering about public API, see [Exports][]. -[including data files]: pages/patterns/data_files +[including data files]: pages/patterns/data-files [backports]: pages/patterns/backports [exports]: pages/patterns/exports diff --git a/docs/pages/tutorials/packaging.md b/docs/pages/tutorials/packaging.md index ddd7f1f3..e59103a7 100644 --- a/docs/pages/tutorials/packaging.md +++ b/docs/pages/tutorials/packaging.md @@ -129,4 +129,4 @@ In [1]: snell? For more about packaging, also see our [packaging guide][]. [version control with git]: https://swcarpentry.github.io/git-novice/ -[packaging guide]: pages/guides/packaging_simple +[packaging guide]: pages/guides/packaging-simple