Test documentation build in pull requests

[tovrstra]

This is the extension of #331 towards the documentation build. These are now also built for each PR and required to pass without error or warning. (Includes a few typo fixes.)

For the bigger picture, see #313

Summary by Sourcery

This pull request extends the Sphinx documentation build workflow to run on pull requests, ensuring that documentation builds pass without errors or warnings. It also includes minor typo fixes in the workflow configuration.

• CI:
  • Updated the Sphinx GitHub Actions workflow to run on pull requests in addition to pushes to the main branch.
  • Configured the Sphinx build to treat warnings as errors and continue on warnings, ensuring a clean build.

[deepsource-io]

Here's the code health analysis summary for commits 4896520..394178e. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Shell	✅ Success		View Check ↗
Python	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request extends the functionality of the documentation build process by ensuring that documentation is built and verified for each pull request. It includes changes to the GitHub Actions workflow files to trigger documentation builds on pull requests and introduces stricter error handling for the Sphinx build process. Additionally, it includes minor typo fixes.

File-Level Changes

Files	Changes
.github/workflows/sphinx.yaml .github/workflows/release.yaml	Updated GitHub Actions workflows to include documentation build checks on pull requests and fixed minor typos.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @tovrstra - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[PaulWAyers]

LGTM

[tovrstra]

Thanks for reviewing!