Skip to content

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

Closed
shravantc opened this issue Jul 22, 2015 · 14 comments · Fixed by #1634
Closed

Documentation version selection broken with Mkdocs #1480

shravantc opened this issue Jul 22, 2015 · 14 comments · Fixed by #1634
Labels
Bug A bug Status: blocked Issue is blocked on another issue

Comments

@shravantc
Copy link

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.

image

@d0ugal
Copy link
Contributor

d0ugal commented Jul 22, 2015

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?

@d0ugal
Copy link
Contributor

d0ugal commented Jul 22, 2015

Yeah, so this line isn't working for some reason: https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/readthedocs/base.html#L29

@d0ugal
Copy link
Contributor

d0ugal commented Jul 22, 2015

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/

@gregmuellegger gregmuellegger added the Bug A bug label Jul 24, 2015
@jhamman
Copy link

jhamman commented Aug 12, 2015

I'm getting the same behavior on this site: http://vic.readthedocs.org/en/master/.

All the links under Versions and On GitHub send you to a url with the word "None" at the end.

@gregmuellegger
Copy link
Contributor

@d0ugal I tried using mkdocs/mkdocs@74031a0 of mkdocs, but it still appended None on the version select links. Is there anything that we need to adjust on the RTD end?

@d0ugal
Copy link
Contributor

d0ugal commented Aug 20, 2015

@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.

@d0ugal
Copy link
Contributor

d0ugal commented Aug 20, 2015

I was planning to come and figure it out, but hadn't found the time yet :)

@gregmuellegger
Copy link
Contributor

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?

@jhamman
Copy link

jhamman commented Aug 26, 2015

@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.

gregmuellegger added a commit to gregmuellegger/mkdocs that referenced this issue Sep 7, 2015
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
gregmuellegger added a commit to gregmuellegger/mkdocs that referenced this issue Sep 7, 2015
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
@gregmuellegger
Copy link
Contributor

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 🏆

@gregmuellegger
Copy link
Contributor

Blocked by mkdocs/mkdocs#721
Blocked by #1634

@gregmuellegger gregmuellegger added the Status: blocked Issue is blocked on another issue label Sep 7, 2015
@jhamman
Copy link

jhamman commented Oct 2, 2015

Just giving this a bump since it seems like the fixes are not blocked anymore.

@d0ugal
Copy link
Contributor

d0ugal commented Oct 2, 2015

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.

@agjohnson agjohnson changed the title Version Selection throws maze found.. Documentation version selection broken with Mkdocs Dec 29, 2015
@dnrce
Copy link

dnrce commented Jan 22, 2016

MkDocs 0.15.0 was released today. Is this now unblocked?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Status: blocked Issue is blocked on another issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants