Fix RTD build by including config file. #2274
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 now required as layed out here: https://blog.readthedocs.com/migrate-configuration-v2/ Work towards pex-tool#2267.
cognifloyd
approved these changes
Nov 3, 2023
benjyw
approved these changes
Nov 3, 2023
jsirois
added a commit
to jsirois/pex
that referenced
this pull request
Nov 3, 2023
The fix in pex-tool#2274 that introduced `.readthedocs.yaml` (the name documented by RTD currently to use for the config file) was blind to the fact we already had a `.readthedocs.yml` file. It appears to be the case that `.readthedocs.yml` is both read by RTD and preferred; so RTD build errors persisted. Fix this by merging the config files and sticking with the current reccomended name of `.readthedocs.yaml`. More work towards pex-tool#2267.
jsirois
added a commit
that referenced
this pull request
Nov 3, 2023
The fix in #2274 that introduced `.readthedocs.yaml` (the name documented by RTD currently to use for the config file) was blind to the fact we already had a `.readthedocs.yml` file. It appears to be the case that `.readthedocs.yml` is both read by RTD and preferred; so RTD build errors persisted. Fix this by merging the config files and sticking with the current reccomended name of `.readthedocs.yaml`. More work towards #2267.
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.
This is now required as layed out here:
https://blog.readthedocs.com/migrate-configuration-v2/
Work towards #2267.