The Wayback Machine - https://web.archive.org/web/20201107174835/https://github.com/adafruit/circuitpython/issues/3479
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

readthedocs removes file extension from URLs #3479

Open
PTS93 opened this issue Sep 27, 2020 · 3 comments
Open

readthedocs removes file extension from URLs #3479

PTS93 opened this issue Sep 27, 2020 · 3 comments

Comments

@PTS93
Copy link

@PTS93 PTS93 commented Sep 27, 2020

If you got to f.e. https://circuitpython.readthedocs.io/en/latest/CONTRIBUTING.html
Clicking on any link that is supposed to go to a markdown file in the github repo yields a 404 because it removes the file extension.
F.e. instead of linking to https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT.md (notice the .md)
it links to https://github.com/adafruit/circuitpython/blob/main/CODE_OF_CONDUCT

The markdown file this page is based on is correct though, it includes the file ending in the URL. So I assume this gets lost in the processing somewhere.

@sw23
Copy link

@sw23 sw23 commented Oct 24, 2020

I explored this issue as part of hacktoberfest and found that this is actually an issue with the recommonmark package, and has been fixed (though a new package version has yet to be released):
readthedocs/recommonmark#181
readthedocs/recommonmark@e821106

It's probably worth waiting for a new package version.

@PTS93
Copy link
Author

@PTS93 PTS93 commented Oct 24, 2020

Great find, thanks. I nudged them if they might consider a release, this seems to have been the only commit since may.

@tannewt
Copy link
Collaborator

@tannewt tannewt commented Oct 26, 2020

@sw23 thank for looking into this! Please feel free to mention me on any PRs to circuitpython or libraries that you want to count for Hacktoberfest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.