Run sphinx directly on readthedocs #1919
Merged
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.
In #1918 I noticed that errors on the doc build are not failing the readthedocs build. This is because sphinx runs
hatch run docs:rtd
, which in turn runssphinx-build
with no options, which does not fail on warnings.Instead I think it's better to let readthedocs manage calling sphinx itself, and manage dependencies itself too for caching reasons. This allows it to use the configuration options that we define in the
Makefile
, which is the only way to configure sphinx to error on warnings.I also updated the
hatch run docs:build
script to usemake html
, so it also catches sphinx warnings and turn them into errors.TODO: