Skip to content

Allow alternative configuration filename for "Path for .readthedocs.yaml" #10468

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
mcarans opened this issue Jun 25, 2023 · 3 comments
Closed
Labels
Needed: more information A reply from issue author is required

Comments

@mcarans
Copy link

mcarans commented Jun 25, 2023

What's the problem this feature will solve?

The filename .readthedocs.yaml makes sense in the root, but when using the "Path for .readthedocs.yaml" experimental feature, it makes more sense to allow the filename to be different since the full path is supplied. (In my case I want to drop the prefixed "." and use this path documentation/readthedocs.yaml.

Describe the solution you'd like

Allow any filename or at least allow dropping the prefixed "." when using "Path for .readthedocs.yaml"

@humitos
Copy link
Member

humitos commented Jun 26, 2023

Hi @mcarans. Thanks for opening this issue. We talked about this in the past and we decided to only support one filename to avoid confusions and reduce the complexity around the configuration file.

Can you expand on the benefits about using a different filename different than .readthedocs.yaml?

@humitos humitos added the Needed: more information A reply from issue author is required label Jun 26, 2023
@mcarans
Copy link
Author

mcarans commented Jun 26, 2023

@humitos There isn't any need for the configuration file to be a hidden file if it is in a subfolder like documentation. In fact, it would be better if it wasn't a hidden file.

@humitos
Copy link
Member

humitos commented Aug 10, 2023

We are not going to allow other filenames for now. I'm closing this issue but we can revisit in the future.

@humitos humitos closed this as completed Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required
Projects
None yet
Development

No branches or pull requests

2 participants