Use only one variant of the config file #7918
Merged
Conversation
This file contains hidden or 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
Why `.readthedocs.yaml`? - Configuration files usually start with a `.` so they are hidden in unix like systems. - `.yaml` is the official and recommended extension for yaml files. We could go a little further and use a feature flag to stop finding the other ones. ref #7915
humitos
approved these changes
Feb 16, 2021
Comment on lines
+8
to
+11
| .. note:: | ||
|
|
||
| Some other variants like ``readthedocs.yaml``, ``.readthedocs.yml``, etc | ||
| are deprecated. |
There was a problem hiding this comment.
I'd vote to remove this completely.
There was a problem hiding this comment.
yeah, I was thinking the same, but didn't want to make it disappear just like that and confuse people using an old variant.
There was a problem hiding this comment.
This seems fine for now. We can remove it later. 👍
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.
Why
.readthedocs.yaml?.so they are hidden inunix like systems.
.yamlis the official and recommended extension for yaml files.We could go a little further and use a feature flag to stop finding
the other ones.
ref #7915