Skip to content

Edit on GitHub link is broken for Markdown files in Sphinx projects #1483

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
gregmuellegger opened this issue Jul 24, 2015 · 5 comments
Closed
Labels
Bug A bug Status: blocked Issue is blocked on another issue

Comments

@gregmuellegger
Copy link
Contributor

Here is an example: http://docs.readthedocs.org/en/latest/changelog.html

The changelog source is in changelog.md but the link goes to https://github.com/rtfd/readthedocs.org/blob/master/docs/changelog.rst.

@ericholscher
Copy link
Member

This was a Sphinx bug. I pushed a patch into Sphinx that fixes it, and gives us the proper source_suffix in the template context, we just need to make sure we are respecting it.

sphinx-doc/sphinx#1876

@gregmuellegger
Copy link
Contributor Author

I reviewed the code and I think we are passing source_suffix through from the build to the API to the function that builds the github URL. So we should be good, but we now need to wait for a new Sphinx release :(

@gregmuellegger
Copy link
Contributor Author

Blocked by next Sphinx release ">1.3.1"

@gregmuellegger gregmuellegger added the Status: blocked Issue is blocked on another issue label Sep 14, 2015
@ericholscher
Copy link
Member

This is fixed in the code base & waiting on a Sphinx release: sphinx-doc/sphinx#2278

@thewebchameleon
Copy link

i don't think this is fixed, I still get relocated to the .rst version of the file and the OP's issue has not been resolved as per the example link

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

No branches or pull requests

4 participants