Readthedocs.org: Flyout links incorrect on Mkdocs projects

[dnrce]

GitHub links in the sidebar footer contain an extraneous path. For example, on http://tracks.readthedocs.org/en/latest/upgrading/ the "View" link points to https://github.com/TracksApp/tracks/blob/master/home/docs/checkouts/readthedocs.org/user_builds/tracks/checkouts/latest/doc/Upgrading.md.

[marcelstoer]

1480 was closed even though the root cause seems to be the same. Yet, the flyout links are still incorrect.

[sahilTakiar]

I was trying to fix this and believe I found the cause, I was able to get a working version for a MkDocs based project.

More info here: https://github.com/rtfd/readthedocs.org/commit/98b5d34316917e0bdb26404c6f3816108ce7f42e

[sahilTakiar]

@agjohnson any thoughts on my comment in https://github.com/rtfd/readthedocs.org/commit/98b5d34316917e0bdb26404c6f3816108ce7f42e

I have tested the change locally using the directions here: https://docs.readthedocs.org/en/latest/install.html#installing-read-the-docs and it works for a MkDocs and Sphinx based projects.

[sahilTakiar]

@ericholscher do you have any thoughts on this? If I have a fix that is tested, so I can create the PR. Want to get this fixed as we just went live with our ReadTheDocs integration.

[ericholscher]

@sahilTakiar Definitely send the PR over!

[kenorb]

The same here.

Steps to reproduce:

1. Go to this page.
2. Click _Read the Docs_ in the bottom, then View or Edit.

The links are like:

https://github.com/geerlingguy/drupal-vm/blob/master/home/docs/checkouts/readthedocs.org/user_builds/drupal-vm/checkouts/latest/docs/index.md
https://github.com/geerlingguy/drupal-vm/edit/master/home/docs/checkouts/readthedocs.org/user_builds/drupal-vm/checkouts/latest/docs/index.md

which aren't valid.

[laughinghan]

Same here: http://mathquill.readthedocs.io/en/latest/

[marcelstoer]

2066 was merged hours ago and thus this should now be closed I guess.

[dnrce]

Thanks @marcelstoer. I just rebuilt and the issue persists so I don't believe this should be closed until the change is deployed.

[ericholscher]

Just deployed this, so it should hopefully be fixed.

[dnrce]

It appears to be. Thanks @sahilTakiar and @ericholscher!

[marcelstoer]

It works for the OP's project at http://tracks.readthedocs.org but it doesn't work for any other project listed here in the comments: http://docs.drupalvm.com, http://mathquill.readthedocs.io and http://nodemcu.readthedocs.io (mine) still have this odd ".../docs/checkouts/readthedocs.org/..." URLs. What's the difference between them? I just built mine again to be sure.

[markekraus]

same for me. The view and edit URLs have the same '.../docs/checkouts/readthedocs.org/...' in them

I thought maybe it was related to having edit_uri set in mckdocs.yml, but removing it and rebuilding seems to make no difference. @marcelstoer doesn't even have the set in their mkdcos.yml.

• https://psraw.readthedocs.io/en/latest/
• https://psmsgraph.readthedocs.io/en/latest/
• https://autodocumentsexample.readthedocs.io/en/latest/

[PowerKiKi]

edit_uri is a feature that appeared in mkdocs 0.16 and that would help in solving that I think. But it seems RTFD is still using mkdocs 0.15 according to my build logs.

Is an upgrade to mkdocs 0.16 planed ? Or is it something that could be contributed by someone relatively easily ?

[stsewd]

I didn't know that this issue was already reported, I'm fixing this in https://github.com/rtfd/readthedocs.org/pull/3525

[ryanpitts]

Sorry to ping in a closed issue, but I'm seeing the same broken "View/Edit on GitHub" links in this project, which is using Mkdocs for the build: http://fieldguide.opennews.org/en/latest/. Both URLs have the ".../docs/checkouts/readthedocs.org/..." path stuff appended.

I just triggered a fresh build to see if that would clear things up (it had been a while), but no luck. Is there a setting I need to update?

[stsewd]

Links are correct for me

[ryanpitts]

Hmmm. I hoped maybe it was just a caching thing so I cleared that out, but the links are still broken for me. (See URL at bottom of screenshot)

[PowerKiKi]

Links are correct for me too. Might be CDN related cache?

[stsewd]

Yeah, I think so, CDN or ISP caching

[ryanpitts]

Hey! Sure enough, those links are correct for me now too. (I promise I tried clearing caches, multiple browsers, etc etc.) Thanks for the response!