Skip to content
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

Edit on Github link pointing to non-existant branch #4441

Closed
ba66e77 opened this issue Jul 27, 2018 · 3 comments
Closed

Edit on Github link pointing to non-existant branch #4441

ba66e77 opened this issue Jul 27, 2018 · 3 comments
Labels
Bug A bug

Comments

@ba66e77
Copy link

ba66e77 commented Jul 27, 2018

Details

Expected Result

A description of what you wanted to happen
I want the Edit on Github link to point to the correct branch on github based on what version of the docs people are looking at, rather than pointing to 'master' on all versions

Actual Result

Regardless of version of the docs, the Edit on Github link points to the "master" branch, which does not exist in our repo. Seems like there has to be configuration setting there that I'm just not seeing for some reason. The Default Branch in the Advanced Settings is set to use the 9.x branch.

@humitos
Copy link
Member

humitos commented Jul 27, 2018

Thanks for reporting this. I'm not sure what's the solution yet, but there are some issues related to this one already: #1820 and #1802

In this particular case, it does worth to mention that it's a mkdocs project.

@ba66e77
Copy link
Author

ba66e77 commented Jul 27, 2018

Thanks for the response, @humitos. I looked at those before posting but, even though they have the same observed issue (the Edit on Github link is inaccurate), they don't seem directly relevant. We're not referencing a tag nor are we using git submodules.

@danepowell
Copy link

I think this is due to mkdocs' version of the readthedocs theme not supporting reading the active github_version: mkdocs/mkdocs#1578

The fix is pretty simple, downstream projects just need to set edit_uri to be the correct path: https://github.com/mkdocs/mkdocs/blob/master/docs/user-guide/configuration.md#edit_uri

Obviously it would be ideal if this worked out of the box though, which is why I opened the upstream issue with mkdocs.

@ba66e77 ba66e77 closed this as completed Aug 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug
Projects
None yet
Development

No branches or pull requests

3 participants