Add favicon support to doc and fix codacy badge

analogdevicesinc · Dec 9, 2021 · 202d0a1 · 202d0a1
1 parent a013643
commit 202d0a1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/images/favicon.png → doc/source/_static/favicon.png b/images/favicon.png → doc/source/_static/favicon.png
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -45,6 +45,7 @@
     "sphinx.ext.githubpages",
     "sphinx_rtd_theme",
     "myst_parser",
+    "sphinx-favicon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -67,7 +68,10 @@
 #
 html_theme = "furo"
 
+html_title = f"{project} {release}"
+favicons = ["favicon.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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ["_static"]
diff --git a/requirements_doc.txt b/requirements_doc.txt
@@ -2,3 +2,4 @@ sphinx>=2.0
 sphinx-rtd-theme
 myst-parser
 furo
+sphinx-favicon