diff --git a/docs/_static/virtual_ship_logo_inverted_no_text.png b/docs/_static/virtual_ship_logo_inverted_no_text.png new file mode 100644 index 00000000..41ba70d6 Binary files /dev/null and b/docs/_static/virtual_ship_logo_inverted_no_text.png differ diff --git a/docs/_static/virtual_ship_logo_no_text.png b/docs/_static/virtual_ship_logo_no_text.png new file mode 100644 index 00000000..d1910ee9 Binary files /dev/null and b/docs/_static/virtual_ship_logo_no_text.png differ diff --git a/docs/conf.py b/docs/conf.py index 5992e2fc..41b1d72f 100644 --- a/docs/conf.py +++ b/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": """ - - - - """, - "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 = [ diff --git a/environment.yml b/environment.yml index 370b8a82..e5f6ea5b 100644 --- a/environment.yml +++ b/environment.yml @@ -31,5 +31,5 @@ dependencies: - pandoc - sphinx-copybutton - sphinx-autodoc-typehints - - furo + - pydata-sphinx-theme - sphinx-autobuild