Fix docs build and add it to CI workflow #328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this is consistent with how readthedocs behaves; so make sure we detect issues more quickly
Long argument form `--fail-on-warning` was added in Sphinx 7.3, which doesn’t run on Python 3.8
Sheshuk
approved these changes
May 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #327.
In addition to fixing the warning itself, this includes measures to more quickly discover similar issues in the future:
This PR now treats warnings as errors in our docs Makefile, consistent with ReadTheDocs’ configuration. It also builds docs as part of our CI workflows, so we notice future issues on every PR and can fix them before merging broken docs into
main.