Add dmf-utils logo

.gitignore

@@ -186,4 +186,5 @@ cython_debug/
 autosummary/
 
 # Include DMF env module
-!dmf/env/
+!dmf/env/
+!docs/assets/*.svg

README.md

@@ -1,5 +1,14 @@
 
-# DMF Utils
+<p align="center">
+  <a href="https://github.com/memory-formation/dmf-utils">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./docs/assets/dmf-utils-dark.svg">
+        <img alt="dmf-utils" src="./docs/assets/dmf-utils.svg">
+    </picture>
+  </a>
+</p>
+
+-------
 
 [![PyPI version](https://badge.fury.io/py/dmf-utils.svg)](https://pypi.org/project/dmf-utils/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dmf-utils)

docs/conf.py

@@ -52,8 +52,6 @@
     'pillow': ('https://pillow.readthedocs.io/en/stable/', None),
     'torch': ('https://pytorch.org/docs/stable/', None),
     'sklearn': ('https://scikit-learn.org/stable/', None),
-    'h5py': ('http://docs.h5py.org/en/stable/', None),
-    'joblib': ('https://joblib.readthedocs.io/en/latest/', None),
 }
 autodoc_default_options = {"members": True, "inherited-members": True, "show-inheritance": True}
 
@@ -64,7 +62,9 @@
 
 html_theme = "pydata_sphinx_theme"
 html_favicon = "https://brainvitge.org/website/wp-content/themes/brainvitge/favicon.png"
-html_logo = "https://raw.githubusercontent.com/memory-formation/.github/main/logos/brainvitge.png"
+#html_logo = "https://raw.githubusercontent.com/memory-formation/.github/main/logos/brainvitge.png"
+html_logo = "assets/dmf-utils-inline.svg"
+html_logo_dark = "assets/dmf-utils-inline-dark.svg"
 html_theme_options = {
     "github_url": "https://github.com/memory-formation/dmf-utils",
     # "navbar_start": ["navbar-logo"],
@@ -84,6 +84,10 @@
             "type": "url",
         },
     ],
+     "logo": {
+        "image_light": html_logo,
+        "image_dark": html_logo_dark,
+    },
 }
 html_context = {
     "github_user": "memory-formation",

docs/index.rst

@@ -1,5 +1,15 @@
-Welcome to DMF Utils's documentation!
-=====================================
+
+
+.. image:: ./assets/dmf-utils.svg
+  :alt: dmf-utils
+  :target: https://github.com/memory-formation/dmf-utils/
+  :class: only-light
+
+.. image:: ./assets/dmf-utils-dark.svg
+  :alt: dmf-utils
+  :target: https://github.com/memory-formation/dmf-utils/
+  :class: only-dark
+
 
 .. image:: https://badge.fury.io/py/dmf-utils.svg
    :target: https://pypi.org/project/dmf-utils/