Skip to content

Commit f34f94a

Browse files
Update theme to pydata-sphinx (#105)
* Update theme to pydata-sphinx * DOC: Update header with updated logo and text
1 parent 3d94342 commit f34f94a

File tree

4 files changed

+23
-21
lines changed

4 files changed

+23
-21
lines changed
35.1 KB
Loading
34.7 KB
Loading

docs/conf.py

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
from __future__ import annotations
22

33
import importlib.metadata
4-
from typing import Any
54

65
project = "Virtual Ship Parcels"
76
copyright = "2024, Emma Daniëls"
@@ -29,29 +28,32 @@
2928
".venv",
3029
]
3130

32-
html_theme = "furo"
31+
html_theme = "pydata_sphinx_theme"
3332

34-
html_theme_options: dict[str, Any] = {
35-
"footer_icons": [
33+
html_theme_options = {
34+
"logo": {
35+
"text": "Virtual Ship Parcels",
36+
"image_light": "virtual_ship_logo_no_text.png",
37+
"image_dark": "virtual_ship_logo_inverted_no_text.png",
38+
},
39+
"use_edit_page_button": True,
40+
"github_url": "https://github.com/OceanParcels/virtualship",
41+
"icon_links": [
3642
{
37-
"name": "GitHub",
38-
"url": "https://github.com/OceanParcels/virtualship",
39-
"html": """
40-
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
41-
<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>
42-
</svg>
43-
""",
44-
"class": "",
45-
},
43+
"name": "Conda Forge",
44+
"url": "https://anaconda.org/conda-forge/virtualship", # required
45+
"icon": "fa-solid fa-box",
46+
"type": "fontawesome",
47+
}
4648
],
47-
"source_repository": "https://github.com/OceanParcels/virtualship",
48-
"source_branch": "main",
49-
"source_directory": "docs/",
50-
"light_logo": "virtual_ship_logo.png",
51-
"dark_logo": "virtual_ship_logo_inverted.png",
52-
"sidebar_hide_name": True,
5349
}
54-
50+
html_context = {
51+
"github_user": "OceanParcels",
52+
"github_repo": "virtualship",
53+
"github_version": "main",
54+
"doc_path": "docs",
55+
}
56+
html_show_sourcelink = False
5557
html_static_path = ["_static"]
5658

5759
myst_enable_extensions = [

environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ dependencies:
3131
- pandoc
3232
- sphinx-copybutton
3333
- sphinx-autodoc-typehints
34-
- furo
34+
- pydata-sphinx-theme
3535
- sphinx-autobuild

0 commit comments

Comments
 (0)