Skip to content

Remove logic around finding a configuration file inside directories #4669

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
stsewd opened this issue Sep 27, 2018 · 6 comments
Closed

Remove logic around finding a configuration file inside directories #4669

stsewd opened this issue Sep 27, 2018 · 6 comments
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Improvement Minor improvement to code
Milestone

Comments

@stsewd
Copy link
Member

stsewd commented Sep 27, 2018

This should only search for a configuration file on the project's root.

https://github.com/rtfd/readthedocs.org/blob/6261427e662d9c3733568c33f760c5f5a2100c6d/readthedocs/config/config.py#L956-L956

As we can face some weird cases like a third party dependency having a readthedocs.yml file. Also, looks like travis only search for a configuration file on the root. And we have on our docs that we only search on the root.

Ref #4668

@stsewd stsewd added Good First Issue Good for new contributors Improvement Minor improvement to code Accepted Accepted issue on our roadmap labels Sep 27, 2018
@sobolevn
Copy link

Can we still provide a way to specify your conf.py location in the configuration?

Use-case: I have my application in root folder and my docs in docs/ subfolder.
I do not want to have extra files that might interact with my app.

Real world example: https://github.com/wemake-services/wemake-python-styleguide

So, can we have an conf_path (or similar) option in readthedocs.yml?

@stsewd
Copy link
Member Author

stsewd commented Sep 28, 2018

@sobolevn with our rtd configuration file v2, we have an option to specify the conf.py path (but you still need to put the readthedos.yaml in the root of your project). Right now you can to use the admin panel.

Our v2 will be available soon!

@stsewd
Copy link
Member Author

stsewd commented Sep 28, 2018

This change has nothing to do with the conf.py file btw, it's about the readthedocs.yml file

@Mihir-Karbelkar
Copy link

Is this issue open because I would like to work on this as my first bug. All the "Good First Issue" have a PR opened for them. Can you help me out?

@humitos
Copy link
Member

humitos commented Oct 31, 2018

I think it was closed by #4755. Thanks!

@humitos humitos closed this as completed Oct 31, 2018
@ppwwyyxx
Copy link

How about allowing a few other candidate locations other than root, like docs/readthedocs.yml as well?
Putting all kinds of config files for different services all in root is quite annoying. Despite they are hidden, they still show up on github.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

6 participants