fix: some broken links fuond by html-proofer (#223)

Signed-off-by: Henry Schreiner <[email protected]>

Gemfile

@@ -28,6 +28,11 @@ end
 group :development do
   # Verify good coding practices in Ruby files
   gem 'rubocop', '~>1.52', require: false
+
+  # Check links. Use:
+  #   bundle exec jekyll build
+  #   bundle exec htmlproofer --assume_extension '.html' ./_site
+  gem 'html-proofer'
 end
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem

Gemfile.lock

@@ -1,22 +1,47 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    Ascii85 (1.1.0)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
+    afm (0.2.2)
     ast (2.4.2)
+    async (2.6.2)
+      console (~> 1.10)
+      fiber-annotation
+      io-event (~> 1.1)
+      timers (~> 4.1)
     colorator (1.1.0)
     concurrent-ruby (1.2.2)
+    console (1.17.2)
+      fiber-annotation
+      fiber-local
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     eventmachine (1.2.7)
     ffi (1.15.5)
+    fiber-annotation (0.2.0)
+    fiber-local (1.0.0)
     forwardable-extended (2.6.0)
     google-protobuf (3.23.3-x86_64-darwin)
     google-protobuf (3.23.3-x86_64-linux)
+    hashery (2.1.2)
+    html-proofer (5.0.7)
+      addressable (~> 2.3)
+      async (~> 2.1)
+      nokogiri (~> 1.13)
+      pdf-reader (~> 2.11)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+      zeitwerk (~> 2.5)
     http_parser.rb (0.8.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-event (1.2.2)
     jekyll (4.3.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
@@ -55,12 +80,22 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
+    nokogiri (1.15.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
+    pdf-reader (2.11.0)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
     public_suffix (5.0.1)
     racc (1.7.1)
     rainbow (3.1.1)
@@ -84,21 +119,29 @@ GEM
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    ruby-rc4 (0.1.5)
     safe_yaml (1.0.5)
     sass-embedded (1.63.6)
       google-protobuf (~> 3.23)
       rake (>= 13.0.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    timers (4.3.5)
+    ttfunk (1.7.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
     unicode-display_width (2.4.2)
     wdm (0.1.1)
     webrick (1.8.1)
+    yell (2.2.2)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
+  html-proofer
   jekyll (~> 4.3)
   jekyll-feed
   jekyll-seo-tag

_config.yml

@@ -3,7 +3,6 @@ email: [email protected]
 description: >-
   This guide is maintained by the scientific Python community for the benefit of
   fellow scientists and research software engineers.
-url: "https://learn.scientific-python.org"
 github_username: scientific-python
 source: docs
 
@@ -23,7 +22,7 @@ search_enabled: true
 # Aux links for the upper right navigation
 aux_links:
   "Scientific Python Cookie":
-    - "//github.com/scientific-python/cookie"
+    - "https://github.com/scientific-python/cookie"
 
 gh_edit_link: true
 gh_edit_link_text: "View source for this page on GitHub."

docs/pages/guides/gha_basic.md

@@ -205,8 +205,9 @@ shown on the summary page.
 You can output annotations, as well; these show up inline on the code in the PR.
 This can be done by
 [setting special double-colon outputs](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message),
-like `echo "::error file=app.js,line=1::Missing semicolon"`. See []() for a
-plugin to do this with pytest.
+like `echo "::error file=app.js,line=1::Missing semicolon"`. See
+[pytest-github-actions-annotate-failures](https://github.com/pytest-dev/pytest-github-actions-annotate-failures)
+for a plugin to do this with pytest.
 
 You can also do this
 [by supplying matchers](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md),
@@ -274,7 +275,7 @@ There are also a few useful tools installed which can really simplify your
 workflow or adding custom actions. This includes system package managers (like
 brew, chocolaty, NuGet, Vcpkg, etc), as well as a fantastic cross platform one:
 
-- [pipx](https://github.com/pypy/pipx): This is pre-installed on all runners
+- [pipx](https://github.com/pypa/pipx): This is pre-installed on all runners
   (GitHub uses to set up other things), and is kept up to date. It enables you
   to use any PyPI application in a single line with `pipx run <app>`.
 

docs/pages/guides/packaging_simple.md

@@ -169,7 +169,7 @@ This is tool specific.
 - [Flit info here](https://flit.readthedocs.io/en/latest/pyproject_toml.html#sdist-section).
   Flit requires manual inclusion/exclusion in many cases, like using a dirty
   working directory.
-- [PDM info here](https://pdm.fming.dev/pyproject/tool-pdm/#include-and-exclude-package-files).
+- [PDM info here](https://pdm-backend.fming.dev/build_config/#include-or-exclude-files).
 - Setuptools still uses `MANIFEST.in`.
 
 {: .warning }

docs/pages/guides/style.md

@@ -441,7 +441,7 @@ when clearly better (please always use them, they are faster) if you set
       args: ["--py38-plus"]
 ```
 
-[pyupgrade]: https://github.com/asottile/pyupgrade:
+[pyupgrade]: https://github.com/asottile/pyupgrade
 
 {: .note }
 

docs/pages/principles/design.md

@@ -269,6 +269,6 @@ Python can be used to build scientific tools that last and grow well over time.
 
 [the UNIX philosophy]: https://en.wikipedia.org/wiki/Unix_philosophy
 [Duck typing]: https://en.wikipedia.org/wiki/Duck_typing
-["Stop Writing Classes"]: https:k//www.youtube.com/watch?v=o9pEzgHorH0&t=193s
+["Stop Writing Classes"]: https://youtube.com/watch?v=o9pEzgHorH0&t=193s
 
 <!-- prettier-ignore-end -->