ci: run hyperlink checking with quiet mode flag enabled (#2476)

* ci: run hyperlink checking with quiet mode flag enabled This is intended to make it easier to find and fix broken links; in quiet mode, the linkcheck builder suppresses much of its reporting to stdout, including successful (ok) check results -- and so what appears in GitHub Actions console, for example, with the quiet flag in place should be more concise and actionable. * Add CHANGELOG entry * Update changelog/2476.trivial.rst --------- Co-authored-by: Nick Murphy <namurphy@cfa.harvard.edu>
PlasmaPy · Jan 25, 2024 · 1093e93 · 1093e93
1 parent 46f59fc
commit 1093e93
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/.github/workflows/check-hyperlinks.yml b/.github/workflows/check-hyperlinks.yml
@@ -28,4 +28,4 @@ jobs:
       run: sudo apt-get install graphviz pandoc
 
     - name: Check hyperlinks
-      run: tox -e build_docs_linkcheck
+      run: tox -e build_docs_linkcheck -- -q
diff --git a/changelog/2476.trivial.rst b/changelog/2476.trivial.rst
@@ -0,0 +1 @@
+Enabled the ``sphinx`` linkchecker in quiet mode to make it easier to find problem links from the console output.