-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
A configuration file was not found (after 2.6.6 update) #4668
Comments
I have also seen this error for several of my projects. I have also tried to specify config file manually in "Advanced settings", but it did not work. |
I'm going to look at this now |
I have the same problem since this morning: https://readthedocs.org/projects/adios2-adaptable-io-system-version-2/builds/7852603/ |
Ok, I found the problem (with @nikolay-bushkov's project at least). What happens if that you have a Not sure if we want to allow that ( |
@sobolevn can you share your rtd project? Or see if your case is the same as above ^ |
@williamfgc your case is the same as above https://github.com/ornladios/ADIOS2/blob/master/thirdparty/pybind11/pybind11/.readthedocs.yml |
You can solve this by moving your |
@stsewd Thanks for your help! I thought the build was restricted to ./docs/ that yml file is under thridparty. Can I set up a filter? |
RTD have access to the whole repo, as some projects require to run the project to extract docstrings. You should put your rtd config file in the root of the project. If you mean having that file there but ignoring it, currently it's not possible. You should rename that file. |
@stsewd yeah, I looked into the docs and I couldn't find anything related. IT could be a useful feature. For example, if we have two projects (user_guide, developers_guide) under the same repo, or like in my case if we depend on thirdparty that must not be modified? Since those are common scenarios, what's the best practice? |
So, we decide that we don't want to support this behaviour (and looks like it doesn't match our docs anyway). So, if moving the config file to the project's root solve this, we can close this issue, I'll open a new one to track the deletion of the logic that finds config files inside other directories. |
I think there are some ideas about having multiple configurations, but I don't think we are going to support that. As we will need to need to find a way to choose which project to run. This is the more close thing that we are going to support #4354 (comment). Also, I think rtd is designed for one documentation per repo. |
We are going to remove the finding logic, so that should fix that case. |
@stsewd great! Thanks! Keep up with the great work in rtd! |
Just in case, a workaround is creating your own |
@stsewd adding .readthedocs.yml solved our issue. Thanks! |
This is now required according to readthedocs/readthedocs.org#4668
This is now required according to readthedocs/readthedocs.org#4668
Now required per readthedocs/readthedocs.org#4668
Now required per readthedocs/readthedocs.org#4668
Should fix build errors a la readthedocs/readthedocs.org#4668
* Add spelling_language property To specify the natural language for which spelling should be checked. * Add .readthedocs.yaml Now required per readthedocs/readthedocs.org#4668
Details
Expected Result
Successful build.
Actual Result
Build failed even in the branch that was not updated. It seems that update to 2.6.6 break it. Any ideas how to fix it?
The text was updated successfully, but these errors were encountered: