diff --git a/README.md b/README.md index 1f83219b2..753dd5c7f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ # MNE Logo The MNE-BIDS-Pipeline + + + **The MNE-BIDS-Pipeline is a full-flegded processing pipeline for your MEG and EEG data.** It operates on data stored according to the [Brain Imaging Data Structure (BIDS)](https://bids.neuroimaging.io/). Under the hood, it uses [MNE-Python](https://mne.tools). + + ## 💡 Basic concepts and features + + * 🐾 Data processing as a sequence of standard processing steps. * ⏩ Steps are cached to avoid unnecessary recomputation. * ⏏ Data can be "ejected" from the pipeline at **any** stage. No lock-in! @@ -16,6 +23,8 @@ Structure (BIDS)](https://bids.neuroimaging.io/). Under the hood, it uses [MNE-P * 💻 Execution via an easy-to-use command-line utility. * 🆘 Helpful error messages in case something goes wrong. + + ## 📘 Installation and usage instructions Please find the documentation at diff --git a/docs/hooks.py b/docs/hooks.py new file mode 100644 index 000000000..0869cbc43 --- /dev/null +++ b/docs/hooks.py @@ -0,0 +1,24 @@ +import logging +from typing import Dict, Any + +from mkdocs.config.defaults import MkDocsConfig + +logger = logging.getLogger('mkdocs') + +config_updated = False + + +# Ideally there would be a better hook, but it's unclear if context can +# be obtained any earlier +def on_template_context( + context: Dict[str, Any], + template_name: str, + config: MkDocsConfig, +) -> None: + """Update the copyright in the footer.""" + global config_updated + if not config_updated: + config_updated = True + now = context['build_date_utc'].strftime('%Y/%m/%d') + config.copyright = f'{config.copyright}, last updated {now}' + logger.info(f'Updated copyright to {config.copyright}') diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ceb64422c..5ee37b9a0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -2,7 +2,7 @@ site_name: MNE-BIDS-Pipeline repo_url: https://github.com/mne-tools/mne-bids-pipeline edit_uri: edit/main/docs/source/ # Keep this in sync with pyproject.toml and index.md -site_description: The MNE-BIDS-Pipeline is a standardized pipeline for automated processing of MEG and EEG data. +site_description: The MNE-BIDS-Pipeline is a full-flegded processing pipeline for your MEG and EEG data. site_author: MNE-BIDS-Pipeline authors docs_dir: ./source site_dir: ./site @@ -17,6 +17,7 @@ theme: - navigation.tracking palette: primary: white + custom_dir: overrides extra: social: - icon: fontawesome/brands/github @@ -31,6 +32,8 @@ extra: version: provider: mike default: stable +hooks: + - ./hooks.py copyright: Copyright © MNE-BIDS-Pipeline authors diff --git a/docs/source/index.md b/docs/source/index.md index 4e50c4827..c379da754 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,12 +1,10 @@ -What is the MNE-BIDS-Pipeline? -============================== +# What is the MNE-BIDS-Pipeline? -**The MNE-BIDS-Pipeline is a standardized processing pipeline for your MEG and -EEG data.** - -It operates on raw data stored according to the Brain Imaging Data -Structure (BIDS). Processing is controlled using a simple human-readable -configuration file. +{% + include-markdown "../../README.md" + start="" + end="" +%} [Learn more](features/features.md){: .md-button }   [Get started :fontawesome-solid-rocket:](getting_started/install.md){: .md-button .md-button--primary } diff --git a/pyproject.toml b/pyproject.toml index 534507d5b..0015e45e8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,7 @@ [project] name = "mne-bids-pipeline" -description = "A standardized processing pipeline for your MEG and EEG data" +# Keep in sync with README.md: +description = "A full-flegded processing pipeline for your MEG and EEG data" readme = "README.md" requires-python = ">=3.8" license = {file = "LICENSE.txt"}