Skip to content

fix: use hyphenated page slugs in internal doc links #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henryiii merged 1 commit into from
Jun 9, 2026
Merged

fix: use hyphenated page slugs in internal doc links #796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/guides/gha_pure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions docs/pages/guides/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/guides/packaging_classic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/guides/packaging_compiled.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
8 changes: 4 additions & 4 deletions docs/pages/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/patterns/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/tutorials/packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading