From 2142c6d2b90e1f554ffb4f76a39e68b85e138fcb Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 11 Jan 2023 12:07:48 +0100 Subject: [PATCH 1/5] Sphinx 6: Use logo_url instead of logo --- sphinx_rtd_theme/layout.html | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index bb0c069a2..466b229bf 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -133,22 +133,24 @@
{%- block sidebartitle %} - {%- if logo and theme_logo_only %} + {%- if ( logo or logo_url ) and theme_logo_only %} {%- else %} {{ project }} {%- endif %} - {%- if logo %} - {#- Not strictly valid HTML, but it's the only way to display/scale - it properly, without weird scripting or heaps of work - #} - {%- if sphinx_version_info < (4, 0) -%} - - {%- else %} - + {%- if sphinx_version_info < (4, 0) -%} + {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #} + {%- if logo %} + + {%- endif %} + {# Behavior since Sphinx 4 #} + {%- else %} + {% if logo_url %} + {%- endif %} {%- endif %} + {%- if theme_display_version %} From 1e11b3a0e09299bdca74aac16ec2f5526b7335d3 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 11 Jan 2023 15:04:19 +0100 Subject: [PATCH 2/5] Handle removal of favicon template context + refactor display of logo and link so it's easier to see what belongs to <4.0 and what is >=4.0 --- sphinx_rtd_theme/layout.html | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index 466b229bf..c37b99c38 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -41,11 +41,13 @@ {%- endfor -%} {#- FAVICON #} - {%- if favicon %} - {%- if sphinx_version_info < (4, 0) -%} - - {%- else %} - + {%- if sphinx_version_info < (4, 0) -%} + {%- if favicon %} + + {%- endif %} + {%- else %} + {%- if favicon_url %} + {%- endif %} {%- endif -%} @@ -134,24 +136,31 @@ {%- block sidebartitle %} {%- if ( logo or logo_url ) and theme_logo_only %} - - {%- else %} - {{ project }} - {%- endif %} {%- if sphinx_version_info < (4, 0) -%} {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #} + {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} {%- if logo %} + + {%- endif %} {# Behavior since Sphinx 4 #} {%- else %} {% if logo_url %} - + + + {%- endif %} {%- endif %} - + {%- else %} + {%- if sphinx_version_info < (4, 0) -%} + {{ project }} + {%- else %} + {{ project }} + {%- endif %} + {%- endif %} {%- if theme_display_version %} {%- set nav_version = version %} From 19aaba5a4a13dd6ebd822041e20cdad505ec581e Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Thu, 12 Jan 2023 12:06:15 +0100 Subject: [PATCH 3/5] Adds a favicon to the demo --- docs/conf.py | 1 + docs/demo/static/favicon.ico | Bin 0 -> 766 bytes 2 files changed, 1 insertion(+) create mode 100644 docs/demo/static/favicon.ico diff --git a/docs/conf.py b/docs/conf.py index 5a27944c3..25d002c02 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -70,6 +70,7 @@ html_logo = "demo/static/logo-wordmark-light.svg" html_show_sourcelink = True +html_favicon = "demo/static/favicon.ico" htmlhelp_basename = slug diff --git a/docs/demo/static/favicon.ico b/docs/demo/static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..42e8969edc8c3345e10706d5e1c4f57ed92469e1 GIT binary patch literal 766 zcmZQzU<5)11py$*!tjELfkBLcfk6X^6@b_Qh(Y4GKt!M$!}^6i46mO*!li_|;*5eo xAi$sm1`0sOQHc+9rIHeod8G1*cMk&t$o&ZON#&F3e^SjyS5KOKKz|J-001VUA|?O; literal 0 HcmV?d00001 From f3556515a13b423f77bebd1b5c225f1af90fd3ba Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Fri, 13 Jan 2023 17:29:33 +0100 Subject: [PATCH 4/5] Import condensed version logic @agjohnson --- sphinx_rtd_theme/layout.html | 52 ++++++++++++------------------------ 1 file changed, 17 insertions(+), 35 deletions(-) diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index c37b99c38..f2dabc904 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -40,16 +40,14 @@ {%- endfor -%} - {#- FAVICON #} - {%- if sphinx_version_info < (4, 0) -%} - {%- if favicon %} - - {%- endif %} - {%- else %} - {%- if favicon_url %} - - {%- endif %} - {%- endif -%} + {#- FAVICON + favicon_url is the only context var necessary since Sphinx 4. + In Sphinx<4, we use favicon but need to prepend path info. + #} + {%- set _favicon_url = favicon_url | default(pathto('_static/' + (favicon or ""), 1)) %} + {%- if favicon_url or favicon %} + + {%- endif %} {#- CANONICAL URL (deprecated) #} {%- if theme_canonical_url and not pageurl %} @@ -135,32 +133,16 @@
{%- block sidebartitle %} - {%- if ( logo or logo_url ) and theme_logo_only %} - - {%- if sphinx_version_info < (4, 0) -%} - {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #} - {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} - {%- if logo %} - - - + {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #} + {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} + {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %} + {%- set _root_doc = root_doc|default(master_doc) %} + + {% if not theme_logo_only %}{{ project }}{% endif %} + {%- if logo or logo_url %} + {%- endif %} - {# Behavior since Sphinx 4 #} - {%- else %} - {% if logo_url %} - - - - {%- endif %} - {%- endif %} - - {%- else %} - {%- if sphinx_version_info < (4, 0) -%} - {{ project }} - {%- else %} - {{ project }} - {%- endif %} - {%- endif %} + {%- if theme_display_version %} {%- set nav_version = version %} From 0739023be57616fe9e069e92c025fa39817cd67c Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Tue, 17 Jan 2023 18:07:34 +0100 Subject: [PATCH 5/5] Update sphinx_rtd_theme/layout.html Co-authored-by: Anthony --- sphinx_rtd_theme/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index f2dabc904..94a40cc1c 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -137,7 +137,7 @@ {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %} {%- set _root_doc = root_doc|default(master_doc) %} - + {% if not theme_logo_only %}{{ project }}{% endif %} {%- if logo or logo_url %}