docs: 📚 update favicon

docs: 📚 update favicon docs: 📚 update favicon
noshita · Dec 10, 2023 · 54b6cec · 54b6cec
1 parent 72f6df7
commit 54b6cec
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 2 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -26,7 +26,7 @@ jobs:
       - name: Install dependencies
         run: |
             python -m pip install --upgrade pip
-            pip install sphinx pydata-sphinx-theme sphinx-autobuild sphinx-gallery sphinxcontrib-bibtex myst-nb nbsphinx  numpydoc matplotlib seaborn sphinx-sitemap
+            pip install sphinx pydata-sphinx-theme sphinx-autobuild sphinx-gallery sphinxcontrib-bibtex myst-nb nbsphinx numpydoc matplotlib seaborn sphinx-sitemap sphinx-favicon
             if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
             pip install -e .
       - name: Sphinx build

diff --git a/doc/_static/img/favicon.svg → doc/_static/favicon.svg b/doc/_static/img/favicon.svg → doc/_static/favicon.svg
diff --git a/doc/_static/img/favicon_32.png → doc/_static/favicon_32.png b/doc/_static/img/favicon_32.png → doc/_static/favicon_32.png
diff --git a/doc/conf.py b/doc/conf.py
@@ -48,6 +48,7 @@
     "numpydoc",
     "myst_nb",
     "sphinx_sitemap",
+    "sphinx_favicon",
 ]
 
 # this is needed for some reason...
@@ -203,7 +204,15 @@
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = "_static/img/favicon_32.png"
+# html_favicon = "_static/img/favicon_32.png"
+favicons = [
+    {"href": "favicon.svg"},  # => use `_static/icon.svg`
+    {"href": "favicon_32.png"},
+    {
+        "rel": "apple-touch-icon",
+        "href": "https://doc.ktch.dev/apple-touch-icon.png",
+    },
+]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/pyproject.toml b/pyproject.toml
@@ -73,6 +73,7 @@ sphinx-autobuild = "^2021.3"
 sphinx-gallery = "^0.11"
 sphinx-sitemap = "^2.5.0"
 sphinxcontrib-bibtex = "^2.5"
+sphinx-favicon = "^1.0.1"
 
 [build-system]
 build-backend = "poetry.core.masonry.api"