Add the logo

README.md

@@ -1,4 +1,10 @@
-# The `pyrealm` package
+
+<!-- markdownlint-disable-next-line MD041 MD033 -->
+<img
+  alt="The pyrealm logo: a green leaf over the shining sun."
+  src="/docs/source/_static/images/pyrealm_logo.png" width=50%>
+
+---
 
 [![PyPI - Version](https://img.shields.io/pypi/v/pyrealm)](https://pypi.org/project/pyrealm/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrealm)

docs/source/conf.py

@@ -29,6 +29,8 @@
 # -- Project information -----------------------------------------------------
 
 project = "pyrealm: Ecosystem Models in Python"
+html_logo = "_static/images/pyrealm_logo_white_background.png"
+html_favicon = "_static/images/pyrealm_favicon.png"
 
 current_year = datetime.today().strftime("%Y")
 copyright = "2020-" + current_year + ", Pyrealm Developers"
@@ -213,11 +215,11 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
 
 # +
 html_theme_options = {
-    "logo_only": False,
-    "display_version": True,
+    "logo_only": True,
+    "version_selector": True,
     "prev_next_buttons_location": "top",
     "style_external_links": False,
-    "style_nav_header_background": "grey",
+    "style_nav_header_background": "white",
     # Toc options
     "collapse_navigation": False,
     "sticky_navigation": True,

docs/source/index.md

@@ -22,13 +22,19 @@ language_info:
   version: 3.11.9
 ---
 
-# The `pyrealm` package
+<!-- markdownlint-disable-next-line MD041-->
+```{image} /_static/images/pyrealm_logo.png
+:width: 50%
+:align: center
+:alt: The pyrealm logo: a green leaf over the shining sun.
+```
 
 The `pyrealm` package provides Python implementations of models of plant productivity
-and demography. The package is in active development and currently provides the
-following modules:
+and demography.
+
+# The `pyrealm` package
 
-## Module overview
+The package is in active development and currently provides the following modules:
 
 The `core` module
 : Contains fundamental utilities and physics functionality shared across the

pyproject.toml

@@ -71,7 +71,7 @@ netcdf4 = "^1.6.3"
 pydocstyle = "^6.1.1"
 sphinx = "^7.0.0"
 sphinx-external-toc = "^1.0.0"
-sphinx-rtd-theme = "^2.0.0"
+sphinx-rtd-theme = "^3.0.0"
 sphinxcontrib-bibtex = "^2.6.1"
 xarray = "^2024.6.0"