Allow for period as a prefix and yaml extension for config file #4512
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
stsewd
reviewed
Aug 13, 2018
readthedocs/config/config.py
Outdated
| code=CONFIG_REQUIRED, | ||
| ) | ||
| raise ConfigError('No configuration file found', | ||
| code=CONFIG_REQUIRED) |
There was a problem hiding this comment.
Our style guide is something like
raise ConfigError(
'Text',
code=CONFIG_REQUIRED
)| @@ -137,6 +145,14 @@ def test_load_unknow_version(tmpdir): | |||
| assert excinfo.value.code == VERSION_INVALID | |||
|
|
|||
|
|
|||
| def test_yaml_extension(tmpdir): | |||
| """ Make sure it's capable of loading the 'readthedocs' file with a 'yaml' extension. """ | |||
There was a problem hiding this comment.
There are spaces in the sides of this docstring
| @@ -790,6 +806,13 @@ def test_raise_config_not_supported(): | |||
| assert excinfo.value.code == CONFIG_NOT_SUPPORTED | |||
|
|
|||
|
|
|||
| @pytest.mark.parametrize("correct_config_filename", | |||
| [prefix + "readthedocs." + extension for prefix in {"", "."} | |||
| for extension in {"yml", "yaml"}]) | |||
|
Also, there is a test that needs to be changed https://travis-ci.org/rtfd/readthedocs.org/jobs/415587982#L970 |
|
Sorry this took me a while! Hopefully this should pass now :) |
stsewd
approved these changes
Aug 24, 2018
| @@ -1620,3 +1643,6 @@ def test_submodules_recursive_explict_default(self): | |||
| assert build.submodules.include == [] | |||
| assert build.submodules.exclude == [] | |||
| assert build.submodules.recursive is False | |||
|
|
|||
|
|
|||
|
|
|||
There was a problem hiding this comment.
I guess this extra lines shouldn't be here
agjohnson
removed
the
PR: work in progress
|
Looks great! Thanks a ton for porting the PR over! |
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.
Fixes #4102 bringing it over from the build repo.
Ref. readthedocs/readthedocs-build#48