From edbfee6df9ffb0606cadcf76a992e8bfeab56440 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Wed, 14 Jun 2023 09:25:40 +0200 Subject: [PATCH 1/7] Fix html_favicon in documentation WARNING: favicon file '_static/images/favicon.ico' does not exist --- 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 a7302f574..f80d84082 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ html_static_path = ["_static"] html_logo = "_static/images/logo.png" -html_favicon = "_static/images/favicon.ico" +html_favicon = "_static/images/favicon.png" # -- Options for linkcheck builder ------------------------------------------- From ee2291c0b6c4568645fb90b0327bd03aa5974bee Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Wed, 14 Jun 2023 09:38:52 +0200 Subject: [PATCH 2/7] Fix logo in nav bar --- docs/source/conf.py | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index f80d84082..db1a34acf 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -16,7 +16,6 @@ extensions = [ "myst_parser", "sphinx_copybutton", - "jupyterhub_sphinx_theme", ] # The suffix(es) of source filenames. @@ -39,21 +38,30 @@ # -- Options for HTML output ---------------------------------------------- # ref: http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # -html_theme = "jupyterhub_sphinx_theme" +html_theme = "pydata_sphinx_theme" html_theme_options = { + "use_edit_page_button": True, + "github_url": "https://github.com/jupyterhub/binderhub", + "twitter_url": "https://twitter.com/mybinderteam", "icon_links": [ { - "name": "GitHub", - "url": "https://github.com/jupyterhub/mybinder.org-deploy", - "icon": "fa-brands fa-github", + "name": "Discourse", + "url": "https://discourse.jupyter.org/", + "icon": "fa-brands fa-discourse", + "type": "fontawesome" }, - ], - "use_edit_page_button": True, + { + "name": "Team Compass", + "url": "https://jupyterhub-team-compass.readthedocs.io/en/latest/", + "icon": "fa-solid fa-compass", + "type": "fontawesome" + } + ] } html_context = { "github_user": "jupyterhub", "github_repo": "mybinder.org-deploy", - "github_version": "HEAD", + "github_version": "main", "doc_path": "docs/source", } From 120fa42d6edd6f8cae95c6ac1aedd26e6388615a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 14 Jun 2023 07:42:08 +0000 Subject: [PATCH 3/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index db1a34acf..e31489646 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,15 +48,15 @@ "name": "Discourse", "url": "https://discourse.jupyter.org/", "icon": "fa-brands fa-discourse", - "type": "fontawesome" + "type": "fontawesome", }, { "name": "Team Compass", "url": "https://jupyterhub-team-compass.readthedocs.io/en/latest/", "icon": "fa-solid fa-compass", - "type": "fontawesome" - } - ] + "type": "fontawesome", + }, + ], } html_context = { "github_user": "jupyterhub", From f72bb74bd6c8fbdea04311674dc75585392cdf90 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Wed, 14 Jun 2023 11:23:47 +0200 Subject: [PATCH 4/7] Add comment to avoid revert in the future Co-authored-by: Simon Li --- docs/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index e31489646..155a56b49 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -61,6 +61,7 @@ html_context = { "github_user": "jupyterhub", "github_repo": "mybinder.org-deploy", + # Branch name is needed to ensure the `Edit on GitHub` button works "github_version": "main", "doc_path": "docs/source", } From 86cb40134c55207626ba2d86b86078bd073301ef Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 19 Sep 2023 14:33:33 +0200 Subject: [PATCH 5/7] Keep using jupyterhub_sphinx_theme The bug about html_logo has been fixed and a new release has been made. --- docs/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 155a56b49..9929563fb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -16,6 +16,7 @@ extensions = [ "myst_parser", "sphinx_copybutton", + "jupyterhub_sphinx_theme", ] # The suffix(es) of source filenames. @@ -38,7 +39,7 @@ # -- Options for HTML output ---------------------------------------------- # ref: http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # -html_theme = "pydata_sphinx_theme" +html_theme = "jupyterhub_sphinx_theme" html_theme_options = { "use_edit_page_button": True, "github_url": "https://github.com/jupyterhub/binderhub", From 4b41406caa044499147f8cf08598779d7bfb8bdf Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 19 Sep 2023 14:43:07 +0200 Subject: [PATCH 6/7] Avoid duplicated icon links --- docs/source/conf.py | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 9929563fb..9f722fad0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,20 +44,6 @@ "use_edit_page_button": True, "github_url": "https://github.com/jupyterhub/binderhub", "twitter_url": "https://twitter.com/mybinderteam", - "icon_links": [ - { - "name": "Discourse", - "url": "https://discourse.jupyter.org/", - "icon": "fa-brands fa-discourse", - "type": "fontawesome", - }, - { - "name": "Team Compass", - "url": "https://jupyterhub-team-compass.readthedocs.io/en/latest/", - "icon": "fa-solid fa-compass", - "type": "fontawesome", - }, - ], } html_context = { "github_user": "jupyterhub", From c1f240b7b98e6f0aaf6c33a2f892eea05a1a1b57 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 19 Sep 2023 14:45:59 +0200 Subject: [PATCH 7/7] Update github link to mybinder.org-deploy --- 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 9f722fad0..3cc5ea8d1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,7 +42,7 @@ html_theme = "jupyterhub_sphinx_theme" html_theme_options = { "use_edit_page_button": True, - "github_url": "https://github.com/jupyterhub/binderhub", + "github_url": "https://github.com/jupyterhub/mybinder.org-deploy", "twitter_url": "https://twitter.com/mybinderteam", } html_context = {