DOC: Changes (#674)

.circleci/config.yml

@@ -7,7 +7,7 @@ orbs:
 # Aliases to reuse
 _imageconfig: &imageconfig
   docker:
-    - image: cimg/base:current-22.04
+    - image: cimg/base:2022.10-22.04
 
 _git: &git
   name: Configure git

.circleci/setup_bash.sh

@@ -1,13 +1,12 @@
-#!/bin/bash -ef
+#!/bin/bash -e
+
+set -o pipefail
 
 # skip job if not in a [circle full] or on main
-export REGEXP="r'(?<=\[circle )(.*)(?=\])'"
 export COMMIT_MESSAGE=$(git log --format=oneline -n 1);
 COMMIT_MESSAGE_ESCAPED=${COMMIT_MESSAGE//\'/\\\'}  # escape '
 export COMMIT_MESSAGE_ESCAPED=${COMMIT_MESSAGE_ESCAPED//\"/\\\'}  # escape "
-export CIRCLE_REQUESTED_JOB=$(
-    python -c "import re; matches = re.findall(pattern=${REGEXP}, string='${COMMIT_MESSAGE_ESCAPED}'); match = '' if not matches else matches[0]; print(match)"
-);
+export CIRCLE_REQUESTED_JOB=$(echo $COMMIT_MESSAGE_ESCAPED | sed -nE 's/^.*\[circle ([^]]+)\].*$/\1/p')
 
 echo "CIRCLE_JOB=$CIRCLE_JOB"
 echo "COMMIT_MESSAGE=$COMMIT_MESSAGE"
@@ -51,6 +50,7 @@ if [[
     ]]; then
         echo "Skip detected, exiting job ${CIRCLE_JOB} for PR ${CIRCLE_PULL_REQUEST}."
         circleci-agent step halt
+        exit 0
 # Otherwise, run everything
 elif [[ -v CIRCLE_PULL_REQUEST ]]; then
     echo "Running job ${CIRCLE_JOB} for PR ${CIRCLE_PULL_REQUEST}"
@@ -68,7 +68,6 @@ echo "export DOWNLOAD_DATA=\"python -m mne_bids_pipeline._download\"" >> $BASH_E
 # Similar CircleCI setup to mne-python (Xvfb, venv, minimal commands, env vars)
 wget -q https://raw.githubusercontent.com/mne-tools/mne-python/main/tools/setup_xvfb.sh
 bash setup_xvfb.sh
-sudo apt update
 sudo apt install -qq tcsh git-annex-standalone python3.10-venv python3-venv libxft2
 python3.10 -m venv ~/python_env
 wget -q https://raw.githubusercontent.com/mne-tools/mne-python/main/tools/get_minimal_commands.sh

.github/workflows/run-tests.yml

@@ -16,7 +16,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
     - name: Install flake8 and codespell
-      run: pip install flake8 git+https://github.com/codespell-project/codespell#egg=codespel tomli
+      run: pip install flake8 codespell tomli
     - run: make flake
     - run: make codespell-error
   check-doc:

docs/mkdocs.yml

@@ -15,11 +15,16 @@ theme:
         - navigation.tabs
         - navigation.instant  # Load pages via XMLHttpRequest (XHR)
         - navigation.tracking
+    palette:
+        primary: white
 extra:
     social:
         - icon: fontawesome/brands/github
           link: https://github.com/mne-tools/mne-bids-pipeline
           name: GitHub repository
+        - icon: fontawesome/brands/mastodon
+          link: https://fosstodon.org/@mne
+          name: MNE news on Mastodon
         - icon: fontawesome/brands/twitter
           link: https://twitter.com/mne_news
           name: MNE news on Twitter
@@ -84,19 +89,19 @@ nav:
 plugins:
     - search
     - macros
+    - include-markdown
     - mkdocstrings:
         default_handler: python
         handlers:
             python:
-                rendering:
+                options:
                     show_source: true
                     show_if_no_docstring: false
                     show_root_heading: true
                     show_root_full_path: false
                     separate_signature: true
                     line_length: 80  # needed for long param entries
                     show_bases: false
-                selection:
                     docstring_style: numpy
         watch:
             - .

docs/source/v1.1.0.md.inc

@@ -0,0 +1,13 @@
+## v1.1.0-dev (unreleased)
+
+[//]: # (### New features & enhancements)
+
+[//]: # (- Whatever ({{ gh(000) }} by {{ authors.whoever }} )
+
+[//]: # (### Behavior changes)
+
+[//]: # (### Code health)
+
+[//]: # (### Bug fixes)
+
+- None yet

pyproject.toml

@@ -52,6 +52,7 @@ tests = [
     "mkdocs-material",
     "mkdocs-material-extensions",
     "mkdocs-macros-plugin",
+    "mkdocs-include-markdown-plugin",
     "mkdocstrings-python",
     "jinja2",
     "black",  # function signature formatting