Skip to content

Why is RTDs configuration file named readthedocs.yml without leading dot? #2211

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
Paebbels opened this issue May 17, 2016 · 3 comments
Closed

Comments

@Paebbels
Copy link

I found the ReadTheDocs configuration file documentation. The config file readthedocs.yml is currently in beta state.

Why did you name it so, especially without a leading dot?
All other cloud based services, configured by a *.yml file I know of, are using this format: .service.yml.

@agjohnson
Copy link
Contributor

There's no strong reason for it one way or the other, and certainly no standard for this. A number of services and local tooling use non-hidden files, so we followed suit. This is not just a configuration for our service, this file was meant to eventually allow for local execution as well -- to produce a similar command chain as our servers.

I could certainly see having an alternative naming for folks that would rather have these files hidden though. This would be implemented on https://github.com/rtfd/readthedocs-build. Closing the issue here, if anyone wants to take this on, the work should be fairly minimal to support a secondary .readthedocs.yml file.

@Paebbels
Copy link
Author

As far as I can see, it's already implemented. One just needs to extend the file pattern...

config_files = list(find_all(path, CONFIG_FILENAME))

@skirpichev
Copy link
Contributor

readthedocs/readthedocs-build#17 add support for .readthedocs.yml.

ericholscher pushed a commit that referenced this issue Oct 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants