Add favicon to documentation pages

The icon is sourced from https://opengameart.org/content/cc0-food-icons and was selected by inspiration from this particular quote: 'Life is meaningless. But tacos exist.'
daniel-tran · Mar 4, 2023 · fa54ad3 · fa54ad3
1 parent 35209e9
commit fa54ad3
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 0 deletions.
diff --git a/docs/_static/favicon.png b/docs/_static/favicon.png
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -11,6 +11,7 @@
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/doctools.js"></script>
     <script src="_static/sphinx_highlight.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" />
 

diff --git a/docs/index.html b/docs/index.html
@@ -12,6 +12,7 @@
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/doctools.js"></script>
     <script src="_static/sphinx_highlight.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="meaningless" href="modules.html" />

diff --git a/docs/meaningless.html b/docs/meaningless.html
@@ -12,6 +12,7 @@
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/doctools.js"></script>
     <script src="_static/sphinx_highlight.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="meaningless.utilities package" href="utilities.html" />

diff --git a/docs/modules.html b/docs/modules.html
@@ -12,6 +12,7 @@
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/doctools.js"></script>
     <script src="_static/sphinx_highlight.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="meaningless package" href="meaningless.html" />

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -11,6 +11,7 @@
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/doctools.js"></script>
     <script src="_static/sphinx_highlight.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
 

diff --git a/docs/search.html b/docs/search.html
@@ -14,6 +14,7 @@
     <script src="_static/sphinx_highlight.js"></script>
     <script src="_static/searchtools.js"></script>
     <script src="_static/language_data.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="#" />
   <script src="searchindex.js" defer></script>

diff --git a/docs/utilities.html b/docs/utilities.html
@@ -12,6 +12,7 @@
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/doctools.js"></script>
     <script src="_static/sphinx_highlight.js"></script>
+    <link rel="icon" href="_static/favicon.png"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="prev" title="meaningless package" href="meaningless.html" />

diff --git a/sphinx/source/conf.py b/sphinx/source/conf.py
@@ -70,6 +70,9 @@
 #
 html_theme = 'alabaster'
 
+# Use .png instead of .ico because it's easier to edit with tools like Paint.NET
+html_favicon = 'favicon.png'
+
 # Theme options to configure specific aspects of the documentation
 html_theme_options = {
     'description': 'Retrieves, processes and downloads Bible passages from Bible Gateway',

diff --git a/sphinx/source/favicon.png b/sphinx/source/favicon.png