Skip to content

Support .yaml extension for our configuration file #4102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
4 tasks
humitos opened this issue May 16, 2018 · 6 comments
Closed
4 tasks

Support .yaml extension for our configuration file #4102

humitos opened this issue May 16, 2018 · 6 comments
Labels
Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required Needed: patch A pull request is required Needed: tests Tests are required

Comments

@humitos
Copy link
Member

humitos commented May 16, 2018

Currently we only support .yml extension, which make some users (including myself) to be confused.

Probably, we need to just modifiy this file (https://github.com/rtfd/readthedocs-build/blob/bf2d1267c9a3dfa0b94588f23549ec527d5d5532/readthedocs_build/config/config.py#L17) to add the new names with the .yaml extension.

(take into account that .yaml is the official extension of the YAML file: http://yaml.org/faq.html)

We need:

  • modify that file pointed here
  • update the docs to reflect the new file names
  • test this manually
  • write some unit tests

Related: #4100

@humitos humitos added Improvement Minor improvement to code Needed: documentation Documentation is required Needed: tests Tests are required Needed: patch A pull request is required labels May 16, 2018
@stsewd
Copy link
Member

stsewd commented May 17, 2018

Maybe a Good First Issue?

@RichardLitt RichardLitt added the Good First Issue Good for new contributors label May 18, 2018
@StefanoChiodino
Copy link
Contributor

This seems easy enough for me to get me started...hopefully ;)

@StefanoChiodino
Copy link
Contributor

Looking into this I've found mention of environment.yml, mkdocs.yml. No mention of yaml extension for those so either they have the same problem or they are not correctly documented. Would those be look at in another issue?

@agjohnson
Copy link
Contributor

agjohnson commented May 22, 2018

Also, the python YAML implementation will parse JSON as well, perhaps we extend this even further :)

@StefanoChiodino
Copy link
Contributor

Just realised: is .readthedocs.yaml also valid?

@agjohnson
Copy link
Contributor

@StefanoChiodino yup, that is valid, some folks liked the idea of keeping the file hidden

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required Needed: patch A pull request is required Needed: tests Tests are required
Projects
None yet
Development

No branches or pull requests

5 participants