Add .readthedocs.yml config file and pin to Python v2.7. #6668
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
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.
At some point ReadTheDocs switched the default Python version from 2.7 to 3.7 causing all Cabal user guide docs to no longer build. The error surfaces as:
This PR adds a config file which pins to python 2.7, we really should just update cabaldomain.py to be compatible with Python 3.7, but that's for another day.
Verified this branch builds at: https://readthedocs.org/projects/m-renaud-haskell-cabal/builds/10780554/ (not sure if this is publicly visible or not).
Edit: after looking at https://readthedocs.org/projects/cabal/builds/, it appears the docs have built successfully, maybe there's some config in the admin panel :/ In any case, this is the more programmatic way to pin the version.