Merge branch 'main' into main

Author: flpm

.all-contributorsrc

@@ -478,7 +478,8 @@
       "contributions": [
         "code",
         "review",
-        "tutorial"
+        "tutorial",
+        "doc"
       ]
     },
     {

CONTRIBUTING.md

@@ -41,7 +41,7 @@ To fork a repo,
 
 1. Make sure you are logged into GitHub.
 
-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.
+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.
 
 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.
 
@@ -383,7 +383,6 @@ Classifiers are just a list of plain strings
 ```toml
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
 ]
 ```

README.md

@@ -198,7 +198,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/tkoyama010"><img src="https://avatars.githubusercontent.com/u/7513610?v=4?s=100" width="100px;" alt="Tetsuo Koyama"/><br /><sub><b>Tetsuo Koyama</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tkoyama010" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Atkoyama010" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tkoyama010" title="Documentation">📖</a> <a href="#translation-tkoyama010" title="Translation">🌍</a> <a href="#ideas-tkoyama010" title="Ideas, Planning, & Feedback">🤔</a> <a href="#a11y-tkoyama010" title="Accessibility">️️️️♿️</a> <a href="#infra-tkoyama010" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#blog-tkoyama010" title="Blogposts">📝</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tomalrussell"><img src="https://avatars.githubusercontent.com/u/2762769?v=4?s=100" width="100px;" alt="Tom Russell"/><br /><sub><b>Tom Russell</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tomalrussell" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Atomalrussell" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-tomalrussell" title="Tutorials">✅</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tomalrussell"><img src="https://avatars.githubusercontent.com/u/2762769?v=4?s=100" width="100px;" alt="Tom Russell"/><br /><sub><b>Tom Russell</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tomalrussell" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Atomalrussell" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-tomalrussell" title="Tutorials">✅</a> <a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tomalrussell" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Zeitsperre"><img src="https://avatars.githubusercontent.com/u/10819524?v=4?s=100" width="100px;" alt="Trevor James Smith"/><br /><sub><b>Trevor James Smith</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Zeitsperre" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3AZeitsperre" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/tylerjbonnell/"><img src="https://avatars.githubusercontent.com/u/89505514?v=4?s=100" width="100px;" alt="Tyler Bonnell"/><br /><sub><b>Tyler Bonnell</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Tyler-Bonnell" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3ATyler-Bonnell" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Vaunty"><img src="https://avatars.githubusercontent.com/u/68826427?v=4?s=100" width="100px;" alt="Vaunty"/><br /><sub><b>Vaunty</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Vaunty" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3AVaunty" title="Reviewed Pull Requests">👀</a></td>

conf.py

@@ -217,6 +217,8 @@
 linkcheck_ignore = [
     # gnu.org is so strictly rate-limited that retries to it really slow down link-checking... just assume they're fine
     r"https:\/\/.*gnu\.org.*",
+    # this discord link is correct, but unauthenticated it redirects to a sign-up page
+    r"https:\/\/discord\.gg/NQtTTqtv",
 ]
 
 def _post_build(app: "Sphinx", exception: Exception | None) -> None:

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

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

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

@@ -37,7 +37,7 @@ This extension is lightweight.
 
 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).
 
-### [sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)
+### [sphinxext.opengraph](https://github.com/sphinx-doc/sphinxext-opengraph)
 
 OpenGraph is an extension that allows you to add metadata to your documentation
 content pages. [The OpenGraph protocol allows other websites to provide a

documentation/repository-files/license-files.md

@@ -43,7 +43,7 @@ Licenses are legally binding, as such you should avoid trying to create your own
 
 ### Use open permissive licenses when possible
 
-We generally suggest that you use a permissive, license that is [Open Software Initiative (OSI) approved](https://opensource.org/licenses/). If you are
+We generally suggest that you use a permissive, license that is [Open Software Initiative (OSI) approved](https://opensource.org/license). If you are
 [submitting your package to pyOpenSci for peer review](https://www.pyopensci.org/about-peer-review/index.html), then we require an OSI approved
 license.
 

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

@@ -75,7 +75,7 @@ Some badges that you might consider adding to your README file include:
 
 Example: [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/)
 
-* 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)
+* 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)
 
 * Documentation build - Example: ![Docs Building](https://github.com/pyOpenSci/python-package-guide/actions/workflows/build-book.yml/badge.svg)
 
@@ -84,7 +84,7 @@ Example: [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)]
 ```{tip}
 Once you package is accepted to pyOpenSci, we will provide you with
 a badge to add to your repository that shows that it has been reviewed.
-[![pyOpenSci](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-submission/issues/12)
+[![pyOpenSci](https://www.pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-submission/issues/12)
 
 ```
 

examples/extension-hatch/pyproject.toml

@@ -16,8 +16,8 @@ maintainers = [
 description = "An example Python package used to support Python packaging tutorials"
 keywords = ["pyOpenSci", "python packaging"]
 readme = "README"
+license = "BSD-3-Clause"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
 ]

examples/pure-hatch/pyproject.toml

@@ -13,9 +13,9 @@ maintainers = [
 description = "An example Python package used to support Python packaging tutorials"
 keywords = ["pyOpenSci", "python packaging"]
 readme = "README.md"
+license = "BSD-3-Clause"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
 ]
 dependencies = [