Update website with images and branding (#96)

* added banner to homepage and readme * added figure with dataset structure to getting started guide * reworded project tagline * reworded status warning * zulip link to the entire topic, not a specific post * applied NIU branding * added sphinx-sitemap for improved web indexing * allow manual deployment of docs via workflow dispatch * Uses NIU logo without text for footer * change "may" to "can"
neuroinformatics-unit · Dec 19, 2023 · 8de04fe · 8de04fe
1 parent a3671df
commit 8de04fe
Show file tree

Hide file tree

Showing 23 changed files with 90 additions and 14 deletions.
diff --git a/.github/workflows/docs_build_and_deploy.yml b/.github/workflows/docs_build_and_deploy.yml
@@ -28,7 +28,7 @@ jobs:
     needs: build_sphinx_docs
     permissions:
       contents: write
-    if: github.event_name == 'push' && github.ref_type == 'tag'
+    if: (github.event_name == 'push' && github.ref_type == 'tag') || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     steps:
       - uses: neuroinformatics-unit/actions/deploy_sphinx_docs@main

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 # movement
 
-Python tools for analysing body movements across space and time, to aid the study of animal behaviour in neuroscience.
+A Python toolbox for analysing body movements across space and time, to aid the study of animal behaviour in neuroscience.
 
 > [!Note]
 > Read the [documentation](https://movement.neuroinformatics.dev) for more information, including [installation instructions](https://movement.neuroinformatics.dev/getting_started.html#installation) and [examples](https://movement.neuroinformatics.dev/examples/index.html).
@@ -19,6 +19,7 @@ Python tools for analysing body movements across space and time, to aid the stud
 - [License](#license)
 - [Package template](#package-template)
 
+![](docs/source/_static/movement_overview.png)
 
 ## Overview
 
@@ -31,16 +32,14 @@ Find out more on our [mission and scope](https://movement.neuroinformatics.dev/c
 
 ## Status
 > [!Warning]
-> - 🏗️ The package is currently in early development. Stay tuned ⌛
-> - It is not sufficiently tested to be used for scientific analysis
-> - The interface is subject to changes.
+> 🏗️ The package is currently in early development and the interface is subject to change. Feel free to play around and provide feedback.
 
 ## Join the movement
 
 Contributions to movement are absolutely encouraged, whether to fix a bug, develop a new feature, or improve the documentation.
 To help you get started, we have prepared a detailed [contributing guide](https://movement.neuroinformatics.dev/community/contributing.html).
 
-You are welcome to chat with the team on [zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement/topic/Welcome!). You may also [open an issue](https://github.com/neuroinformatics-unit/movement/issues) to report a bug or request a new feature.
+You are welcome to chat with the team on [zulip](https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement). You can also [open an issue](https://github.com/neuroinformatics-unit/movement/issues) to report a bug or request a new feature.
 
 ## License
 ⚖️ [BSD 3-Clause](./LICENSE)

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -9,3 +9,4 @@ sphinx<7.2
 sphinx-autodoc-typehints
 sphinx-design
 sphinx-gallery
+sphinx-sitemap
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -0,0 +1,32 @@
+html[data-theme=dark] {
+    --pst-color-primary: #04B46D;
+    --pst-color-link: var(--pst-color-primary);
+  }
+
+html[data-theme=light] {
+  --pst-color-primary: #03A062;
+  --pst-color-link: var(--pst-color-primary);
+}
+
+body .bd-article-container {
+max-width: 100em !important;
+}
+
+.col {
+flex: 0 0 50%;
+max-width: 50%;
+}
+
+.img-sponsor {
+height: 50px;
+padding-top: 5px;
+padding-right: 5px;
+padding-bottom: 5px;
+padding-left: 5px;
+}
+
+.things-in-a-row {
+display: flex;
+flex-wrap: wrap;
+justify-content: space-between;
+}
diff --git a/docs/source/_static/dark-logo-gatsby.png b/docs/source/_static/dark-logo-gatsby.png
diff --git a/docs/source/_static/dark-logo-niu.png b/docs/source/_static/dark-logo-niu.png
diff --git a/docs/source/_static/dark-logo-swc.png b/docs/source/_static/dark-logo-swc.png
diff --git a/docs/source/_static/dark-logo-ucl.png b/docs/source/_static/dark-logo-ucl.png
diff --git a/docs/source/_static/dark-wellcome-logo.png b/docs/source/_static/dark-wellcome-logo.png
diff --git a/docs/source/_static/dataset_structure.png b/docs/source/_static/dataset_structure.png
diff --git a/docs/source/_static/light-logo-gatsby.png b/docs/source/_static/light-logo-gatsby.png
diff --git a/docs/source/_static/light-logo-niu.png b/docs/source/_static/light-logo-niu.png
diff --git a/docs/source/_static/light-logo-swc.png b/docs/source/_static/light-logo-swc.png
diff --git a/docs/source/_static/light-logo-ucl.png b/docs/source/_static/light-logo-ucl.png
diff --git a/docs/source/_static/light-wellcome-logo.png b/docs/source/_static/light-wellcome-logo.png
diff --git a/docs/source/_static/movement_overview.png b/docs/source/_static/movement_overview.png
diff --git a/docs/source/_templates/footer_end.html b/docs/source/_templates/footer_end.html
@@ -0,0 +1,18 @@
+<div class="things-in-a-row">
+    <a href="https://neuroinformatics.dev/">
+        <img src="{{ pathto('_static/light-logo-niu.png', 1) }}" alt="Sponsors" class="only-light img-sponsor"/>
+        <img src="{{ pathto('_static/dark-logo-niu.png', 1) }}" alt="Sponsors" class="only-dark img-sponsor"/>
+    </a>
+    <a href="https://www.sainsburywellcome.org/web/">
+        <img src="{{ pathto('_static/light-logo-swc.png', 1) }}" alt="Sponsors" class="only-light img-sponsor"/>
+        <img src="{{ pathto('_static/dark-logo-swc.png', 1) }}" alt="Sponsors" class="only-dark img-sponsor"/>
+    </a>
+    <a href="https://www.ucl.ac.uk/gatsby/gatsby-computational-neuroscience-unit">
+        <img src="{{ pathto('_static/light-logo-gatsby.png', 1) }}" alt="Sponsors" class="only-light img-sponsor"/>
+        <img src="{{ pathto('_static/dark-logo-gatsby.png', 1) }}" alt="Sponsors" class="only-dark img-sponsor"/>
+    </a>
+    <a href="https://www.ucl.ac.uk/">
+        <img src="{{ pathto('_static/light-logo-ucl.png', 1) }}" alt="Sponsors" class="only-light img-sponsor"/>
+        <img src="{{ pathto('_static/dark-logo-ucl.png', 1) }}" alt="Sponsors" class="only-dark img-sponsor"/>
+    </a>
+</div>
diff --git a/docs/source/_templates/footer_start.html b/docs/source/_templates/footer_start.html
@@ -0,0 +1,9 @@
+<p class="sphinx-version">
+    {% trans sphinx_version=sphinx_version|e %}Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
+    <br/>
+    </p>
+    <p class="theme-version">
+    {{ _("Built with the") }}
+    <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a>
+    {{ theme_version }}.
+    </p>
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -46,6 +46,7 @@
     "nbsphinx",
     "sphinx_design",
     "sphinx_gallery.gen_gallery",
+    "sphinx_sitemap",
 ]
 
 # Configure the myst parser to enable cool markdown features
@@ -115,11 +116,20 @@
             "icon": "fa-brands fa-github",
             # The type of image to be used (see below for details)
             "type": "fontawesome",
-        }
+        },
+        {
+            "name": "Zulip (chat)",
+            "url": "https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement",
+            "icon": "fa-solid fa-comments",
+            "type": "fontawesome",
+        },
     ],
     "logo": {
         "text": f"{project} v{release}",
     },
+    "footer_start": ["footer_start"],
+    "footer_end": ["footer_end"],
+    "external_links": [],
 }
 
 # Redirect the webpage to another URL
@@ -128,11 +138,16 @@
 # https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html
 github_user = "neuroinformatics-unit"
 html_baseurl = "https://movement.neuroinformatics.dev"
+sitemap_url_scheme = "{link}"
 
 # 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']
+html_css_files = [
+    ("css/custom.css", {"priority": 100}),
+]
+html_favicon = "_static/light-logo-niu.png"
 
 # The linkcheck builder will skip verifying that anchors exist when checking
 # these URLs
@@ -148,7 +163,7 @@
     "ftp": None,
     "mailto": None,
     "movement-github": "https://github.com/neuroinformatics-unit/movement/{{path}}",
-    "movement-zulip": "https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement/topic/Welcome!",
+    "movement-zulip": "https://neuroinformatics.zulipchat.com/#narrow/stream/406001-Movement",
     "conda": "https://docs.conda.io/en/latest/",
     "dlc": "https://www.mackenziemathislab.org/deeplabcut/",
     "gin": "https://gin.g-node.org/{{path}}#{{fragment}}",

diff --git a/docs/source/getting_started.md b/docs/source/getting_started.md
@@ -152,6 +152,8 @@ representation of the dataset by simply typing its name - e.g. `ds` - in a cell.
 
 ### Dataset structure
 
+![](_static/dataset_structure.png)
+
 The movement `xarray.Dataset` has the following dimensions:
 - `time`: the number of frames in the video
 - `individuals`: the number of individuals in the video

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,7 +1,7 @@
 (target-movement)=
 # movement
 
-Python tools for analysing body movements across space and time, to aid the study of animal behaviour in neuroscience.
+A Python toolbox for analysing body movements across space and time, to aid the study of animal behaviour in neuroscience.
 
 ::::{grid} 1 2 2 3
 :gutter: 3
@@ -28,6 +28,8 @@ Get in touch and contribute.
 :::
 ::::
 
+![](_static/movement_overview.png)
+
 ## Overview
 
 Pose estimation tools, such as [DeepLabCut](dlc:) and [SLEAP](sleap:) are now commonplace when processing video data of animal behaviour. There is not yet a standardised, easy-to-use way to process the *pose tracks* produced from these software packages.

diff --git a/docs/source/snippets/get-in-touch.md b/docs/source/snippets/get-in-touch.md
@@ -1,3 +1,3 @@
 :::{admonition} Get in touch
-You are welcome to chat with the team on [Zulip](movement-zulip:). You may also [open an issue](movement-github:issues) to report a bug or request a new feature.
+You are welcome to chat with the team on [Zulip](movement-zulip:). You can also [open an issue](movement-github:issues) to report a bug or request a new feature.
 :::
diff --git a/docs/source/snippets/status-warning.md b/docs/source/snippets/status-warning.md
@@ -1,6 +1,4 @@
 :::{admonition} Status
 :class: warning
-- 🏗️ The package is currently in early development. Stay tuned ⌛
-- It is not sufficiently tested to be used for scientific analysis.
-- The interface is subject to changes.
+The package is currently in early development and the interface is subject to change. Feel free to play around and provide feedback.
 :::