docs: Improve 5.0.x <-> main branch doc linkrot #3031
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This improves, but does not entirely fix, the broken links that result from the autoapi change. It fixes module-level links, but class links still do not work (e.g., /shared-bindings/displayio/Palette.html (5.0.x) is now just /shared-bindings/displayio/#displayio.Palette).
|
Now updated with some additional redirecting logic that should get the per-class pages redirected as well |
tannewt
reviewed
Jun 15, 2020
conf.py
Outdated
| app.info("Could not find redirects file at '%s'" % path) | ||
| return | ||
|
|
||
| # TODO(stephenfin): Add support for DirectoryHTMLBuilder |
There was a problem hiding this comment.
An author of sphinxcontrib-redirects. We should probably remove the TODO here (in fact I thought I had -- I'll make a TODO about it 🤣)
This TODO made sense in the context of the original project, but for use in CircuitPython it does not appear to be relevant. Remove it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This nearly entirely fixes the broken links that result from the autoapi change.
I noted two kinds of breakage:
I'm not aware of other breaking links, but particularly the list of redirects may be incomplete.
This improves, but does not entirely fix, the broken links that result from the autoapi change. It fixes module-level links, but class links still do not work (e.g., /shared-bindings/displayio/Palette.html (5.0.x) is now just /shared-bindings/displayio/#displayio.Palette).