From ac89074a0d7848129370339e480fa85af8fc33f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Krassowski?= <5832902+krassowski@users.noreply.github.com> Date: Thu, 11 Apr 2024 15:27:17 +0100 Subject: [PATCH 1/3] Link to GitHub repo from the docs --- docs/source/conf.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7da4ade09a..5cd79d7cf8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -150,7 +150,17 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -html_theme_options = {"navigation_with_keys": False} +html_theme_options = { + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/jupyter-server/jupyter_server", + "icon": "fab fa-github-square", + } + ], + "navigation_with_keys": False, + "use_edit_page_button": True +} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] From f8cd7e98b0a048448e54fd0ffd11f55c9498a905 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 11 Apr 2024 14:28:29 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5cd79d7cf8..de2c8f7a6e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -159,7 +159,7 @@ } ], "navigation_with_keys": False, - "use_edit_page_button": True + "use_edit_page_button": True, } # Add any paths that contain custom themes here, relative to this directory. From 681bb3d1e82b8ab5b12ab027b4679ad48d566813 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Krassowski?= <5832902+krassowski@users.noreply.github.com> Date: Thu, 11 Apr 2024 15:46:22 +0100 Subject: [PATCH 3/3] Add html_context to enable links --- docs/source/conf.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index de2c8f7a6e..f23398804d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -162,6 +162,14 @@ "use_edit_page_button": True, } +# Output for github to be used in links +html_context = { + "github_user": "jupyter-server", # Username + "github_repo": "jupyter_server", # Repo name + "github_version": "main", # Version + "doc_path": "docs/source/", # Path in the checkout to the docs root +} + # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = []