-
-
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
Building issue: Asked to contact the support #5532
Comments
Looks like we are writing some stuff in the wrong docs dir, I'm investigating more. |
Ok, I figure out, there is an error in your mkdocs config file The path should be relative to the mkdocs.yml file. |
But, we shouldn't fail like this. We can just keep going the build or raise a more specific error. |
Unfortunately even by changing the path to be realtive to the mkdocs.yml we have this issue :
|
can you try wiping the environment? https://docs.readthedocs.io/en/stable/guides/wipe-environment.html Also, I think I saw this problem a while ago, the thing is that pip doesn't completely install the new mkdocs when updating from 0.17.3, so the old one is used. We are updating the default mkdocs in #5505 If wiping doesn't work, can try with the previous version of |
Wiping the environment worked. The build process now finishes without any fail. |
Ok, so there is another bug here, we are generating the html artifacts, but we are expecting them to exist in other location. The problem about failing randomly is another problem, I think I know the root cause, but I can't replicate it locally. |
Currently we are expecting that all mkdocs projects have their docs in their root, but we generate the artifacts relative to their yaml file, we do the same for sphinx. Fix readthedocs#5532 (comment)
There are some cases were rtd uses the old installed version of mkdocs instead of the one installed by the user, like in readthedocs#5532 (comment) Which gives an error because it's using a yaml file supported only in new mkdocs versions. This is similar to readthedocs#5107
There are some cases were rtd uses the old installed version of mkdocs instead of the one installed by the user, like in readthedocs#5532 (comment) Which gives an error because it's using a yaml file supported only in new mkdocs versions. This is similar to readthedocs#5107
Could I build the documentation by switching to mkdocs 0.17 ? Or would this fail the same way ? |
It would fail too, you can move your docs to the |
Do you mean all the markdown files into |
The mkdocs.yaml file should be in the root of your repo. The rest of files relative to the mkdocs.yaml file |
This is deployed, you can use whatever layout you want :) |
Details
Expected Result
I was expecting my build to succeed.
Here is my readthedocs.yml :
and my requirements.txt :
My mkdocs.yml:
Actual Result
The text was updated successfully, but these errors were encountered: