Skip to content

Commit ad33e3d

Browse files
jameslamblwasser
authored andcommitted
docs: fix links that redirect permanently
1 parent de33771 commit ad33e3d

15 files changed

+21
-19
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To fork a repo,
4141

4242
1. Make sure you are logged into GitHub.
4343

44-
2. Go to the repo you would like to fork, in this case the [Python Packaging Guide](https://www.github.com/pyopensci/python-package-guide) repo.
44+
2. Go to the repo you would like to fork, in this case the [Python Packaging Guide](https://github.com/pyopensci/python-package-guide) repo.
4545

4646
3. In the top right-hand corner of the page there is a 'Fork' button. Click that button. You will be brought to a new page where you will 'Create a new fork'. Feel free to keep all the default inputs and click 'Create fork'. This will create a copy of the repo at `https://github.com/<username>/python-package-guide`, where `<username>` is your GitHub username.
4747

conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,8 @@
217217
linkcheck_ignore = [
218218
# gnu.org is so strictly rate-limited that retries to it really slow down link-checking... just assume they're fine
219219
r"https:\/\/.*gnu\.org.*",
220+
# this discord link is correct, but unauthenticated it redirects to a sign-up page
221+
r"https:\/\/discord\.gg/NQtTTqtv",
220222
]
221223

222224
def _post_build(app: "Sphinx", exception: Exception | None) -> None:

documentation/hosting-tools/publish-documentation-online.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ service. Some of its many features include:
2222

2323

2424
## What is GitHub Pages?
25-
[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) is a free web
25+
[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages) is a free web
2626
hosting service offered by GitHub. Using GitHub pages, you can build your
2727
documentation locally or using a Continuous Integration setup, and then push
2828
to a branch in your GitHub repository that is setup to run the GitHub Pages

documentation/hosting-tools/website-hosting-optimizing-your-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This extension is lightweight.
3737

3838
It [requires that you to add it to your Sphinx `conf.py` extension list and site your documentation base url](https://sphinx-sitemap.readthedocs.io/en/latest/getting-started.html).
3939

40-
### [sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)
40+
### [sphinxext.opengraph](https://github.com/sphinx-doc/sphinxext-opengraph)
4141

4242
OpenGraph is an extension that allows you to add metadata to your documentation
4343
content pages. [The OpenGraph protocol allows other websites to provide a

documentation/repository-files/license-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Licenses are legally binding, as such you should avoid trying to create your own
4343

4444
### Use open permissive licenses when possible
4545

46-
We generally suggest that you use a permissive, license that is [Open Software Initiative (OSI) approved](https://opensource.org/licenses/). If you are
46+
We generally suggest that you use a permissive, license that is [Open Software Initiative (OSI) approved](https://opensource.org/license). If you are
4747
[submitting your package to pyOpenSci for peer review](https://www.pyopensci.org/about-peer-review/index.html), then we require an OSI approved
4848
license.
4949

documentation/repository-files/readme-file-best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Some badges that you might consider adding to your README file include:
7575

7676
Example: [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/)
7777

78-
* Status of tests (pass or fail) - Example: [![CI Build](https://github.com/pandera-dev/pandera/workflows/CI%20Tests/badge.svg?branch=main)](https://github.com/pandera-dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amain)
78+
* Status of tests (pass or fail) - Example: [![CI Build](https://github.com/unionai-oss/pandera/workflows/CI%20Tests/badge.svg?branch=main)](https://github.com/unionai-oss/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amain)
7979

8080
* Documentation build - Example: ![Docs Building](https://github.com/pyOpenSci/python-package-guide/actions/workflows/build-book.yml/badge.svg)
8181

@@ -84,7 +84,7 @@ Example: [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)]
8484
```{tip}
8585
Once you package is accepted to pyOpenSci, we will provide you with
8686
a badge to add to your repository that shows that it has been reviewed.
87-
[![pyOpenSci](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-submission/issues/12)
87+
[![pyOpenSci](https://www.pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-submission/issues/12)
8888
8989
```
9090

locales/es/LC_MESSAGES/documentation.po

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ msgid ""
548548
msgstr ""
549549

550550
#: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:40
551-
msgid "[sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)"
551+
msgid "[sphinxext.opengraph](https://github.com/sphinx-doc/sphinxext-opengraph)"
552552
msgstr ""
553553

554554
#: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:42

locales/ja/LC_MESSAGES/documentation.po

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -515,8 +515,8 @@ msgstr ""
515515
"://sphinx-sitemap.readthedocs.io/en/latest/getting-started.html) 。"
516516

517517
#: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:40
518-
msgid "[sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)"
519-
msgstr "[sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)"
518+
msgid "[sphinxext.opengraph](https://github.com/sphinx-doc/sphinxext-opengraph)"
519+
msgstr "[sphinxext.opengraph](https://github.com/sphinx-doc/sphinxext-opengraph)"
520520

521521
#: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:42
522522
msgid ""

package-structure-code/python-package-build-tools.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You will learn more about the following tools on this page:
2727
- [Twine](https://twine.readthedocs.io/en/stable/), [Build](https://pypa-build.readthedocs.io/en/stable/) + [setuptools](https://setuptools.pypa.io/en/latest/)
2828
- [Flit](https://flit.pypa.io/en/stable/)
2929
- [Hatch](https://hatch.pypa.io/latest/)
30-
- [PDM](https://pdm.fming.dev/latest/)
30+
- [PDM](https://pdm-project.org/latest/)
3131
- [Poetry](https://python-poetry.org/docs/)
3232

3333
## Summary of tools Hatch vs. PDM vs. Poetry (and setuptools)
@@ -229,7 +229,7 @@ Notes:
229229

230230
## PDM
231231

232-
[PDM is a Python packaging and dependency management tool](https://pdm.fming.dev/latest/).
232+
[PDM is a Python packaging and dependency management tool](https://pdm-project.org/latest/).
233233
PDM supports builds for pure Python projects. It also provides multiple layers of
234234
support for projects that have C and C++ extensions.
235235

@@ -249,7 +249,7 @@ packages them with the pure Python files.
249249
:delim: "|"
250250
251251
Use Other Build Backends| ✅| When you setup PDM it allows you to select one of several build back ends including: PDM-core, flit-core and hatchling. PDM also can work with Meson-Python which supports move complex python builds.
252-
Dependency specifications |✅|PDM has flexible support for managing dependencies. PDM defaults to using an open bound (e.g. `requests >=1.2`) approach to dependencies. However you can [customize how you want to add dependencies in case you prefer another approach such as that of Poetry which uses an upper bound limit](https://pdm.fming.dev/latest/usage/dependency/#about-update-strategy).**
252+
Dependency specifications |✅|PDM has flexible support for managing dependencies. PDM defaults to using an open bound (e.g. `requests >=1.2`) approach to dependencies. However you can [customize how you want to add dependencies in case you prefer another approach such as that of Poetry which uses an upper bound limit](https://pdm-project.org/en/latest/usage/dependency/#about-update-strategy).**
253253
Environment lock files |✅|PDM and Poetry are currently the only tools that create environment lock files. Lock files are often most useful to developers creating web apps where locking the environment is critical for consistent user experience. For community-used packages, you will likely never want to use a lock file.
254254
Environment management |✅ | PDM provides environment management support. It supports Python virtual environments, conda and a local `__pypackages__` environment which is a newer option in the Python ecosystem. No extensions are needed for this support.
255255
Select your environment type on install |✅ | When you run `PDM init`, PDM will discover environments that are already on your system and allow you to select one to use for your project.

package-structure-code/python-package-distribution-files-sdist-wheel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ similar content. However if your package has extensions in other languages
148148
or is more complex in its build, the two distributions will be very different.
149149

150150
Also note that we are not discussing conda build workflows in this section.
151-
[You can learn more about conda builds here.](https://conda.io/projects/conda-build/en/latest/user-guide/tutorials/index.html)
151+
[You can learn more about conda builds here.](https://docs.conda.io/projects/conda-build/en/latest/user-guide/tutorials/index.html)
152152
```
153153

154154
(python-source-distribution)=

0 commit comments

Comments
 (0)