ci: run hyperlink checking with quiet mode flag enabled

[jayaddison]

Description

The Sphinx linkcheck builder supports a -q / --quiet flag that reduces output verbosity while continuing to output warnings and errors.

This change enables the flag for the scheduled Check hyperlinks GitHub Actions worklow.

Motivation and context

For projects like this one that feature large numbers of healthy hyperlinks, the default linkchecker output to stdout can be overly verbose, with broken/problem hyperlink reports interspersed among many reports of healthy links, making it hard to collect and find the set of problems to fix.

Note

The linkcheck builder emits a warning when it encounters an HTTP redirect that doesn't match an entry within the linkcheck_allowed_redirects patterns - PlasmaPy has a few of these at the moment - mostly related to GitHub users. Although allowing valid redirects is generally good practice, it is possible to ignore (skip) checking for link patterns by using linkcheck_ignore if necessary.

Related issues

N/A

[github-actions]

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

• Getting ready to contribute and the code contribution workflow
• Using astropy.units and plasmapy.particles
• Coding tips and guidelines
• Writing documentation (in reStructuredText with numpydoc style docstrings).
• Writing tests using pytest
• Adding a changelog entry (needed except for minor changes)

The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:

• Try fixing CI / Python 3.11 test failures first.
• Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer. Please also see our pre-commit troubleshooting guide.
• If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
• If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
• For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples.

We thank you once again!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (46f59fc) 96.93% compared to head (4531afc) 96.93%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2476   +/-   ##
=======================================
  Coverage   96.93%   96.93%           
=======================================
  Files         104      104           
  Lines        9163     9163           
=======================================
  Hits         8882     8882           
  Misses        281      281           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[namurphy]

This is fantastic! Thank you once again!

[jayaddison]

You're welcome @namurphy - it's a good way for me to learn a bit more about how the linkcheck builder is being used in practice. I'll try to remember to check in on the results of the next scheduled linkcheck here; feel free to tag me on an issue in the Sphinx repo if you have any particular feedback too.