add logo and copybutton

zincware · Dec 1, 2024 · 5048e8a · 5048e8a
1 parent 5e1ca66
commit 5048e8a
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 1 deletion.
diff --git a/docs/source/_static/zndraw-dark.svg b/docs/source/_static/zndraw-dark.svg
diff --git a/docs/source/_static/zndraw-light.svg b/docs/source/_static/zndraw-light.svg
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,6 +18,7 @@
 
 extensions = [
     "nbsphinx",
+    "sphinx_copybutton",
 ]
 
 templates_path = ["_templates"]
@@ -29,3 +30,25 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+
+html_theme_options: dict = {
+    "light_logo": "zndraw-light.svg",
+    "dark_logo": "zndraw-dark.svg",
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/zincware/zndraw",
+            "html": "",
+            "class": "fa-brands fa-github fa-2x",
+        },
+    ],
+    "source_repository": "https://github.com/zincware/zndraw",
+    "source_branch": "main",
+    "source_directory": "docs/source/",
+    "navigation_with_keys": True,
+}
+
+# font-awesome logos
+html_css_files = [
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
+]
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,7 @@ znh5md = {version = "^0.3"}
 sphinx = "^8.1.3"
 furo = "^2024.8.6"
 nbsphinx = "^0.9.5"
+sphinx-copybutton = "^0.5.2"
 
 [build-system]
 requires = ["poetry-core"]