Added logo and link to gaitmap ecosystem

mad-lab-fau · Sep 18, 2023 · 61cc27a · 61cc27a
1 parent 67805a3
commit 61cc27a
Show file tree

Hide file tree

Showing 14 changed files with 1,367 additions and 90 deletions.
diff --git a/README.rst b/README.rst
@@ -1,3 +1,8 @@
+.. image:: ./docs/_static/logo/datasets_logo_with_text.png
+   :height: 150px
+
+|
+
 .. image:: https://img.shields.io/pypi/v/gaitmap-datasets
    :target: https://pypi.org/project/gaitmap-datasets/
 .. image:: https://img.shields.io/badge/docs-online-green
@@ -25,6 +30,9 @@ All datasets APIs are built using the
 interface.
 For available datasets see the table below.
 
+This package is part of the gaitmap ecosystem.
+`Learn more <https://gaitmap.readthedocs.io/en/latest/source/user_guide/gaitmap_ecosystem.html>`_
+
 Usage
 -----
 

diff --git a/docs/_build/html b/docs/_build/html
diff --git a/docs/_static/logo/datasets.ico b/docs/_static/logo/datasets.ico
diff --git a/docs/_static/logo/datasets_logo.png b/docs/_static/logo/datasets_logo.png
diff --git a/docs/_static/logo/datasets_logo.svg b/docs/_static/logo/datasets_logo.svg
diff --git a/docs/_static/logo/datasets_logo_with_text.png b/docs/_static/logo/datasets_logo_with_text.png
diff --git a/docs/_static/logo/datasets_logo_with_text.svg b/docs/_static/logo/datasets_logo_with_text.svg
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,6 +42,7 @@
 HERE = Path(__file__).parent
 with (HERE.parent / "README.rst").open() as f:
     out = f.read()
+out = out.replace("./docs/_static/logo/datasets_logo_with_text.png", "./_static/logo/datasets_logo_with_text.png")
 with (HERE / "README.rst").open("w+") as f:
     f.write(out)
 
@@ -112,6 +113,9 @@
 #
 # Activate the theme.
 html_theme = "pydata_sphinx_theme"
+html_favicon = "_static/logo/datasets.ico"
+html_logo = "_static/logo/datasets_logo.png"
+
 html_theme_options = {
     "github_url": URL,
     "show_prev_next": False,
@@ -120,7 +124,7 @@
 # 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".
-# html_static_path = ["_static"]
+html_static_path = ["_static"]
 
 # -- Options for extensions --------------------------------------------------
 # Intersphinx
@@ -162,4 +166,3 @@
     "gaitmap_datasets",
     "https://github.com/mad-lab-fau/gaitmap-datasets/blob/{revision}/{package}/{path}#L{lineno}",
 )
-