-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Documentation version selection broken with Mkdocs #1480
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
Comments
For some reason it is adding a None to the end of the url. I am not sure why. I guess there is an issue getting the current path? |
Yeah, so this line isn't working for some reason: https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/base.html#L29 |
and actually, page title isn't the right thing to put there. We should be putting the URL. You can see it being used incorrectly when you change the version here: http://gluster.readthedocs.org/en/latest/Quick-Start-Guide/Terminologies/ |
I'm getting the same behavior on this site: http://vic.readthedocs.org/en/master/. All the links under |
@d0ugal I tried using mkdocs/mkdocs@74031a0 of mkdocs, but it still appended |
@gregmuellegger Yeah, I think so. I just made the data available, I don't really know how it works on your end, but it looked like you were using the Title incorrectly as the URL so I added that. |
I was planning to come and figure it out, but hadn't found the time yet :) |
I tried to install the mkdocs master in the venv that is used for the rtd build, but the change didn't pick up. The base.html in the filesystem contains the change ... but the build doesn't seem to use it. @d0ugal could there be any other path in RTD that is loading the mkdocs theme templates from except from the mkdocs package in the venv? |
@d0ugal and @gregmuellegger - Can either of you give us an update on where this issue is at? We have live docs on RTD that are not working because of this bug. If there is something I can do to help move this forward, let me know. |
readthedocs.org needs the file name in order to identify the correct source file to link to the same file in other versions of the same documentation or to the source on GitHub. Related readthedocs/readthedocs.org#1480
readthedocs.org needs the file name in order to identify the correct source file to link to the same file in other versions of the same documentation or to the source on GitHub. Related readthedocs/readthedocs.org#1480
I further worked on a fix and finally came up with a robust solution. However for this to work mkdocs needs to merge mkdocs/mkdocs#721 first AND make a new release afterwards. Then we can merge #1634 and finally fix this issue. @d0ugal could you make this happen soonish? That would be 🏆 |
Blocked by mkdocs/mkdocs#721 |
Just giving this a bump since it seems like the fixes are not blocked anymore. |
It is still blocked (mostly by me), MkDocs needs a release. I am super swamped until the end of the month and don't want to do a release I won't be able to support. |
MkDocs 0.15.0 was released today. Is this now unblocked? |
If we switch versions from the options to release-3.7.0-1 on http://gluster.readthedocs.org/en/latest/
the resultant URL gets appended with "None" as in http://gluster.readthedocs.org/en/release-3.7.0-1/None/
also from any page, we cannot view the different versions of the documents, what I observed is the URL fired is mis matching the directory.
The text was updated successfully, but these errors were encountered: