Skip to content

Commit

Permalink
Add button to GitHub Repo
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
prisae authored Dec 4, 2024
1 parent 8d9def3 commit 490a6dd
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@
# Theme config
html_theme = "pydata_sphinx_theme"
html_theme_options = {
"github_url": "https://github.com/PyLops/pylops",
# "logo_only": True,
# "display_version": True,
"logo": {
Expand Down

0 comments on commit 490a6dd

Please sign in to comment.