Simplify GitHub hyperlinks for repository locations in docs #300
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 was inspired by something I noticed in the standard Python documentation. Essentially, we use sphinx's builtin [sphinx.ext.extlinks](https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#module-sphinx.ext.extlinks) extension for adding custom roles to automatically expand external links in a simple manner. For example: - ``:source:`src/example` `` is replaced with the text "src/example" that is hyperlinked to [here](https://github.com/grackle-project/grackle/tree/main/src/example) - ``:code-example:`c_example.c` `` is replaced with the text "c_example.c" that is hyperlinked to [here](https://github.com/grackle-project/grackle/blob/main/src/example/c_example.c) - ``:gh-pr:`235` `` is replaced with the text "gh-pr#235" that is hyperlinked to [here](grackle-project#235)
brittonsmith
approved these changes
May 26, 2025
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 was inspired by something I noticed in the standard Python documentation. Essentially, we use sphinx's builtin sphinx.ext.extlinks extension for adding custom roles to automatically expand external links in a simple manner.
For example:
:source:`src/example`is replaced with the text "src/example" that is hyperlinked to here:code-example:`c_example.c`is replaced with the text "c_example.c" that is hyperlinked to here:gh-pr:`235`is replaced with the text "gh-pr#235" that is hyperlinked to here