Update theme to pydata-sphinx

docs/conf.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import importlib.metadata
-from typing import Any
 
 project = "Virtual Ship Parcels"
 copyright = "2024, Emma Daniëls"
@@ -29,29 +28,32 @@
     ".venv",
 ]
 
-html_theme = "furo"
+html_theme = "pydata_sphinx_theme"
 
-html_theme_options: dict[str, Any] = {
-    "footer_icons": [
+html_theme_options = {
+    "logo": {
+        "text": "Virtual Ship Parcels",
+        "image_light": "virtual_ship_logo_no_text.png",
+        "image_dark": "virtual_ship_logo_inverted_no_text.png",
+    },
+    "use_edit_page_button": True,
+    "github_url": "https://github.com/OceanParcels/virtualship",
+    "icon_links": [
         {
-            "name": "GitHub",
-            "url": "https://github.com/OceanParcels/virtualship",
-            "html": """
-                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
-                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
-                </svg>
-            """,
-            "class": "",
-        },
+            "name": "Conda Forge",
+            "url": "https://anaconda.org/conda-forge/virtualship",  # required
+            "icon": "fa-solid fa-box",
+            "type": "fontawesome",
+        }
     ],
-    "source_repository": "https://github.com/OceanParcels/virtualship",
-    "source_branch": "main",
-    "source_directory": "docs/",
-    "light_logo": "virtual_ship_logo.png",
-    "dark_logo": "virtual_ship_logo_inverted.png",
-    "sidebar_hide_name": True,
 }
-
+html_context = {
+    "github_user": "OceanParcels",
+    "github_repo": "virtualship",
+    "github_version": "main",
+    "doc_path": "docs",
+}
+html_show_sourcelink = False
 html_static_path = ["_static"]
 
 myst_enable_extensions = [

environment.yml

@@ -31,5 +31,5 @@ dependencies:
   - pandoc
   - sphinx-copybutton
   - sphinx-autodoc-typehints
-  - furo
+  - pydata-sphinx-theme
   - sphinx-autobuild