Circuitpython: readthedocs removes file extension from URLs

Created on 27 Sep 2020  路  4Comments  路  Source: adafruit/circuitpython

If you go 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.

bug documentation good first issue help wanted

Most helpful comment

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):
https://github.com/readthedocs/recommonmark/pull/181
https://github.com/readthedocs/recommonmark/commit/e821106417bddaa76b1808cf4fce7d65d2459dd2

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

All 4 comments

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):
https://github.com/readthedocs/recommonmark/pull/181
https://github.com/readthedocs/recommonmark/commit/e821106417bddaa76b1808cf4fce7d65d2459dd2

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

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

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

We could install directly from source in our requirements.txt:

git+https://github.com/readthedocs/recommonmark.git@e821106#egg=recommonmark

I'm happy to send a PR to do this if y'all want.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sommersoft picture sommersoft  路  38Comments

kevinjwalters picture kevinjwalters  路  32Comments

tannewt picture tannewt  路  31Comments

tannewt picture tannewt  路  41Comments

deshipu picture deshipu  路  44Comments