docs: add video embed support

Author: Hem-W

docs/source/conf.py

@@ -13,8 +13,8 @@
 project = 'DOMINO-SEE'
 copyright = '2025, Hui-Min Wang and Xiaogang He (GPL-3.0)'
 author = 'Hui-Min Wang and Xiaogang He'
-version = '0.0.1'
-release = '0.0.1'
+version = '0.0.1-alpha'
+release = '0.0.1-alpha'
 
 # General configuration
 extensions = [
@@ -33,6 +33,7 @@
     'sphinx_autodoc_typehints',  # Better handling of type hints in docstrings
     'sphinxcontrib.bibtex',      # Bibliography support
     'sphinx_design',             # Grid layouts and design elements
+    'sphinxcontrib.video',       # Support for video embedding
 ]
 
 # Add any paths that contain templates
@@ -43,7 +44,7 @@
 
 # The master toctree document
 master_doc = 'index'
-html_title = "Documentation"
+html_title = "DOMINO-SEE Official Documentation"
 
 # List of patterns to exclude from source
 exclude_patterns = ['_build', '**.ipynb_checkpoints']
@@ -58,7 +59,7 @@
 
 # Theme options
 html_theme_options = {
-    "sidebar_hide_name": False,
+    "sidebar_hide_name": True,
     "light_logo": "logo.png",
     "dark_logo": "logo_dark.png",
     "light_css_variables": {

docs/source/index.rst

@@ -8,6 +8,11 @@ Welcome to DOMINO-SEE
 
 **DOMINO-SEE** is a framework for **D**\etection **O**\f **M**\ulti-layer **I**\nterconnected **N**\etwork **O**\ccurrences for **S**\patial **E**\xtreme **E**\vents, leveraging event coincidences analysis and complex networks. It is built using `xarray <https://xarray.pydata.org/en/stable/>`_ and can seamlessly benefit from the parallelization handling provided by `dask <https://dask.org/>`_. Its objective is to make it as simple as possible for users to construct event-based climate network analysis workflows.
 
+.. video:: https://github.com/PREP-NexT/DOMINO-SEE/releases/download/0.0.1-alpha/DOMINO-SEE.Logo.Animation.mp4
+   :width: 100%
+   :poster: ./_static/dominosee_logo.png
+   :alt: DOMINO-SEE introduction video
+
 The name **DOMINO-SEE** represents our approach to detecting and analyzing interconnected occurrences of hydroclimatic extreme events across spatial locations, inspired by the cascade effect of **DOMINO**\es falling in a chain reaction. The **SEE** highlights the framework's ability to capture the spatial synchronization and propagation of extreme events, emphasizing the interconnectedness inherent in complex environmental systems.
 
 .. grid:: 1 2 2 2

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dominosee"
-version = "0.0.1"
+version = "0.0.1-alpha"
 description = "A tool for spatial climate network analysis"
 readme = "README.md"
 authors = [
@@ -54,6 +54,7 @@ docs = [
     "sphinx-autodoc-typehints>=1.15.0",
     "sphinx-design>=0.5.0",
     "sphinxcontrib-bibtex>=2.5.0",
+    "sphinxcontrib-video>=0.2.0",
     "matplotlib",
     "cartopy"
 ]