Update Sphinx usage of favicon to favicon_url

- Fixes wagtail#277 - See sphinx-doc/sphinx#11062 - See https://www.sphinx-doc.org/en/master/extdev/deprecated.html
lb- · Jan 26, 2024 · 0e9f3ab · 0e9f3ab
1 parent 841c0cf
commit 0e9f3ab
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,7 +18,7 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
--   ...
+-   Update `favicon` usage to be the new Sphinx variable `favicon_url` & add default favicon (Sahil Jangra)
 
 ### Security
 

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -12,6 +12,7 @@
 -   Mohammad Areeb
 -   Andy Chosak
 -   Temidayo Azeez
+-   Sahil Jangra
 
 ## Sphinx Typo3 theme
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,7 @@
 # -- Options for HTML output -------------------------------------------
 html_theme = 'sphinx_wagtail_theme'
 html_static_path = []
+html_favicon = 'favicon.ico'
 # -- Options for HTMLHelp output ---------------------------------------
 htmlhelp_basename = 'sphinx_wagtail_themedoc'
 # -- Options for LaTeX output ------------------------------------------

diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/sphinx_wagtail_theme/layout.html b/sphinx_wagtail_theme/layout.html
@@ -23,8 +23,8 @@
     {% block htmltitle %}
         <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
     {% endblock %}
-    {%- if favicon %}
-        <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}" />
+    {%- if favicon_url %}
+        <link rel="shortcut icon" href="{{ pathto(favicon_url, 1) }}" />
     {%- endif %}
 
     {#- Include our own stylesheets -#}
-Original file line number
+Diff line change
@@ Expand Up @@
     ### Fixed
-    -   ...
+    -   Update `favicon` usage to be the new Sphinx variable `favicon_url` & add default favicon (Sahil Jangra)
     ### Security
@@ Expand Down @@