Skip to content

Commit 0746288

Browse files
Link to GitHub repo from the docs (#1415)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent de6d904 commit 0746288

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/source/conf.py

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,25 @@
150150
# Theme options are theme-specific and customize the look and feel of a theme
151151
# further. For a list of options available for each theme, see the
152152
# documentation.
153-
html_theme_options = {"navigation_with_keys": False}
153+
html_theme_options = {
154+
"icon_links": [
155+
{
156+
"name": "GitHub",
157+
"url": "https://github.com/jupyter-server/jupyter_server",
158+
"icon": "fab fa-github-square",
159+
}
160+
],
161+
"navigation_with_keys": False,
162+
"use_edit_page_button": True,
163+
}
164+
165+
# Output for github to be used in links
166+
html_context = {
167+
"github_user": "jupyter-server", # Username
168+
"github_repo": "jupyter_server", # Repo name
169+
"github_version": "main", # Version
170+
"doc_path": "docs/source/", # Path in the checkout to the docs root
171+
}
154172

155173
# Add any paths that contain custom themes here, relative to this directory.
156174
# html_theme_path = []

0 commit comments

Comments
 (0)