Pin docutils and add readthedocs config file #209
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
|
Probably we should be pinning a bit more than just docutils, or specifying a more recent version of sphinx. I'm going to check that out a bit more before merging this. Converting to draft for now. https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#reproducible-builds |
A recent update in docutils breaks builds on readthedocs. This is the suggested work around from readthedocs [1]. [1] - readthedocs/readthedocs.org#8616
Also update the documentation on how to build the docs, and explicitly define the readthedocs config.
BrianJKoopman
force-pushed
the
koopman/docutils-rtd-fix
branch
from
1bbc008
to
202d034
Compare
BrianJKoopman
changed the base branch from
develop
to
koopman/sphinx-html-css-files
BrianJKoopman
added a commit
to simonsobs/ocs
that referenced
this pull request
Oct 29, 2021
This does exactly what we did to fix the rtd builds over in [1]. [1] - simonsobs/socs#209
7 tasks
Merged
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.
Description
A recent update in docutils breaks builds on readthedocs. This is the suggested
work around from [1].
[1] - readthedocs/readthedocs.org#8616
Motivation and Context
A fresh build of the docs on the
developbranch fails: https://readthedocs.org/projects/socs/builds/15099682/How Has This Been Tested?
This PR will test the build in the checks below.
Types of changes
Checklist:
developbranch.