Add button to GitHub Repo #626
Merged
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 personally dislike it a lot when I come to the documentation of a source code, but there is no easy/quick link to the repo, which means I have to google to find the repo ;-) Adding the `"github_url" to the "html_theme_options" should add a GitHub-link-button on the top-right corner, next to the switch for light/dark theme.
|
Nice addition 😄 Our CI builds the doc so you don't need to do it locally, and it seems to have worked: https://pylops--626.org.readthedocs.build/en/626/ I am going to merge this. |
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.
I personally dislike it a lot when I come to the documentation of a source code, but there is no easy/quick link to the code repo, which means I have to google to find the repo ;-)
Adding the
"github_url"to the"html_theme_options"should add a GitHub-link-button on the top-right corner, next to the switch for light/dark theme.I haven't built the PyLops-docs to check it, but this is how it looks on the empymod website:
