docs: add favicon

trumully · Apr 16, 2024 · 3b73e1b · 3b73e1b
1 parent e127859
commit 3b73e1b
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 3 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -24,5 +24,5 @@ repos:
           [
             "-rn",
             "--rcfile=pylintrc",
-            "--ignore-paths=^tests/.*$"
+            "--ignore-paths=^tests/.*$,^docs/.*$",
           ]
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,12 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.napoleon"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx_favicon",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
@@ -29,3 +34,4 @@
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
+favicons = [{"href": "icon.svg"}]
diff --git a/docs/icon.svg b/docs/icon.svg
diff --git a/poetry.lock b/poetry.lock
diff --git a/pylintrc b/pylintrc
@@ -28,6 +28,9 @@ jobs=4
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
 
+ignore-paths=docs/.*$,
+             tests/.*$
+
 
 [MESSAGES CONTROL]
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -26,6 +26,7 @@ pylint = "^3.1.0"
 black = "^24.4.0"
 ruff = "^0.3.7"
 hypothesis = "^6.100.1"
+sphinx-favicon = "^1.0.1"
 
 [tool.black]
 line-length = 88