ENH: Automatically shorten links for GitHub/GitLab #957
Conversation
This file contains 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
|
I think this is pretty cool! +1 on the functionality from me but I haven't given the code a deep look. |
|
I'm trying to fix the codecov tests sorry for the noise |
|
@choldgraf, it's done the PR is ready for review |
choldgraf
approved these changes
Sep 29, 2022
Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
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.
Fixes #841
I discover that Sphinx is already doing the same kind of operation for
kbdLitteral nodes: https://github.com/sphinx-doc/sphinx/blob/5.x/sphinx/builders/html/transforms.pySo I adapted the code to read all the links on the pages (reference nodes). I'm taking the one from GitHub and GitLab at the moment and I'm shortening them using the same structure as the GitHub one i.e.
<username>/<repository>#<id>. If some parameters are missing I just drop it.I added an example here: https://pydata-sphinx-theme--957.org.readthedocs.build/en/957/user_guide/theme-elements.html#link-shortening
let me know what you think!