Added xHydro logos

CHANGELOG.rst

@@ -4,7 +4,7 @@ Changelog
 
 v0.5.0 (unreleased)
 -------------------
-Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Trevor James Smith (:user:`Zeitsperre`).
+Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Trevor James Smith (:user:`Zeitsperre`), Louise Arnal (:user:`lou-a`).
 
 New features and enhancements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -22,6 +22,7 @@ Internal changes
 * Tests can now be run using the `pytest-xdist` plugin for distributed testing. See the `pytest-xdist documentation <https://pytest-xdist.readthedocs.io/en/stable/>`_ for more information. (:pull:`212`).
 * Several tests reliant on online servers and services have been marked as `online` to prevent them from running in contexts where internet access is limited. (:pull:`212`).
 * Many function docstrings and type hints have been updated for accuracy and precision. (:pull:`212`).
+* The `xHydro` project now has a set of logos for use in documentation, the readme, and other materials. (:pull:`217`).
 
 v0.4.0 (2024-10-04)
 -------------------

README.rst

@@ -1,6 +1,6 @@
-======
-xHydro
-======
+======================================
+xHydro |logo| |logo-light| |logo-dark|
+======================================
 
 +----------------------------+-----------------------------------------------------+
 | Versions                   | |pypi| |versions|                                   |
@@ -22,7 +22,7 @@ Hydrological analysis library built with xarray
 Features
 --------
 
-* Easily find and extract geospacial data from the Planetary Computer API and watershed boundaries from the HydroSHEDS API over any area of interest.
+* Easily find and extract geospatial data from the Planetary Computer API and watershed boundaries from the HydroSHEDS API over any area of interest.
 * Calibrate and execute Hydrotel and Raven-emulated hydrological models.
 * Perform optimal interpolation on hydrological data (daily streamflow and indices).
 * Compute hydrological indicators (e.g. n-day peak flow, annual maximum series, low flow, average flow, etc.) over custom date ranges.
@@ -34,6 +34,8 @@ Credits
 
 This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pypackage`_ project template.
 
+This logo was designed by Élyse Fournier (@elysefounier) and Louise Arnal (@lou-a), with inputs from the `xHydro` team.
+
 .. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
 .. _`Ouranosinc/cookiecutter-pypackage`: https://github.com/Ouranosinc/cookiecutter-pypackage
 
@@ -62,6 +64,20 @@ This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pyp
         :target: https://github.com/hydrologie/xhydro/blob/main/LICENSE
         :alt: License
 
+.. |logo| image:: https://raw.githubusercontent.com/hydrologie/xhydro/main/docs/logos/xhydro-logo-small-light.png
+        :target: https://github.com/hydrologie/xhydro
+        :alt: xHydro
+
+.. |logo-light| image:: https://raw.githubusercontent.com/hydrologie/xhydro/main/docs/logos/empty.png
+        :target: https://github.com/hydrologie/xhydro
+        :alt:
+        :class: xhydro-logo-small only-light-inline
+
+.. |logo-dark| image:: https://raw.githubusercontent.com/hydrologie/xhydro/main/docs/logos/empty.png
+        :target: https://github.com/hydrologie/xhydro
+        :alt:
+        :class: xhydro-logo-small only-dark-inline
+
 .. |ossf| image:: https://api.securityscorecards.dev/projects/github.com/hydrologie/xhydro/badge
         :target: https://securityscorecards.dev/viewer/?uri=github.com/hydrologie/xhydro
         :alt: OpenSSF Scorecard

docs/_static/style.css

@@ -0,0 +1,66 @@
+@import url("styles/furo.css");
+
+/* extend furo for inline ".only-dark" elements */
+body .only-dark-inline,
+body .only-light-inline {
+  display: none !important;
+}
+
+@media not print {
+  body[data-theme="dark"] .only-dark-inline,
+  body[data-theme="light"] .only-light-inline {
+    display: inline !important;
+  }
+  @media (prefers-color-scheme: dark) {
+    body:not([data-theme="light"]) .only-dark-inline{
+      display: inline !important;
+    }
+  }
+  @media (prefers-color-scheme: light) {
+    body:not([data-theme="dark"]) .only-light-inline{
+      display: inline !important;
+    }
+  }
+}
+
+@media print {
+  .only-light-inline{
+    display: inline !important;
+  }
+  .only-dark-inline{
+    display: none !important;
+  }
+}
+
+img.xhydro-logo-small.only-dark-inline {
+    width: 125px;
+    height: 125px;
+    margin: 0;
+    padding: 0;
+    background-color: transparent;
+    background-repeat: no-repeat;
+    border: none;
+    border-image-width: 0;
+    background-image: url("xhydro-logo-small-transparent.png");
+}
+
+img.xhydro-logo-small.only-light-inline {
+    width: 125px;
+    height: 125px;
+    margin: 0;
+    padding: 0;
+    background-color: transparent;
+    background-repeat: no-repeat;
+    border: none;
+    border-image-width: 0;
+    background-image: url("xhydro-logo-small-light.png");
+}
+
+img.xhydro-logo-small.no-theme {
+  display: none;
+  width: 0;
+}
+
+button.copybtn.copybtn svg {
+  stroke: var(--color-copybutton);
+}

docs/conf.py

@@ -143,19 +143,31 @@
 #
 html_theme = "furo"
 
-# Theme options are theme-specific and customize the look and feel of a
-# theme further.  For a list of options available for each theme, see the
-# documentation.
+# Theme options are theme-specific and customize the look and feel of a theme further.
+# For a list of options available for each theme, see the documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    "light_logo": "xhydro-logo-light.png",
+    "dark_logo": "xhydro-logo-transparent.png",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 if not os.path.exists("_static"):
     os.makedirs("_static")
-html_static_path = ["_static"]
-
+html_static_path = ["_static", "logos"]
+
+html_sidebars = {
+    "**": [
+        "sidebar/scroll-start.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/navigation.html",
+        "sidebar/ethical-ads.html",
+        "sidebar/scroll-end.html",
+    ]
+}
 
 # -- Options for HTMLHelp output ---------------------------------------
 
@@ -217,3 +229,7 @@
         "hydrology",
     ),
 ]
+
+
+def setup(app):
+    app.add_css_file("style.css")