stepup 2.0.2__tar.gz → 2.0.4__tar.gz

stepup-2.0.4/.deepsource.toml

@@ -0,0 +1,11 @@
+version = 1
+
+[[analyzers]]
+name = "shell"
+
+[[analyzers]]
+name = "python"
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"
+  max_line_length = 100

stepup-2.0.4/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+[Makefile]
+indent_style = tab
+
+[{*.json,*.yml,*.yaml}]
+indent_style = space
+indent_size = 2

stepup-2.0.4/.github/scripts/extract-notes.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# Usage: .github/scripts/extract-notes.sh OWNER/SLUG GITREF
+
+IFS='/'; read -ra REPOSITORY <<<"${1}"
+OWNER=${REPOSITORY[0]}
+SLUG=${REPOSITORY[1]}
+GITREF=${3}
+
+if [[ "${GITREF}" == "refs/tags/"* ]]; then
+    TAG="${GITREF#refs/tags/}"
+    VERSION="${TAG#v}"
+    MAJMIN=${VERSION%.*}
+else
+    TAG="unreleased"
+    VERSION="Unreleased"
+    MAJMIN="dev"
+fi
+
+# Extract the release notes from the changelog
+sed -n "/## \[${VERSION}\]/, /## /{ /##/!p }" docs/changelog.md > notes.md
+
+# Add a link to the release notes
+URL="https://${OWNER}.github.io/${SLUG}/${MAJMIN}/changelog/#${TAG}"
+echo "See [docs/changelog/#${TAG}](${URL}) for more details." >> notes.md
+
+# Remove leading and trailing empty lines
+sed -e :a -e '/./,$!d;/^\n*$/{$d;N;};/\n$/ba' -i notes.md

{stepup-2.0.2 → stepup-2.0.4}/.github/workflows/release.yaml

@@ -1,11 +1,13 @@
 # This workflow is adapted from:
 # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
-# Changed made:
-# - Remove emoticons
-# - Update some actions to more recent versions
 
 name: release
-on: push
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
 
 env:
   # This is not critical
@@ -36,6 +38,16 @@ jobs:
       with:
         name: python-package-distributions
         path: dist/
+    - name: Run release notes script
+      run: >-
+        .github/scripts/extract-notes.sh
+        "${{ github.repository }}"
+        "${{ github.ref }}"
+    - name: Store the release notes
+      uses: actions/upload-artifact@v4
+      with:
+        name: release-notes
+        path: notes.md
 
   publish-to-pypi:
     name: Publish Python distribution to PyPI
@@ -76,25 +88,24 @@ jobs:
       with:
         name: python-package-distributions
         path: dist/
+    - name: Download the release notes
+      uses: actions/download-artifact@v4
+      with:
+        name: release-notes
+        path: notes.md
     - name: Sign the dists with Sigstore
       uses: sigstore/gh-action-sigstore-python@v2.1.1
       with:
         inputs: >-
           ./dist/*.tar.gz
           ./dist/*.whl
-    - name: Prepare release notes
-      run: |
-        TAG=${{ github.event.release.tag_name }}
-        echo "TAG=${TAG}" >> $GITHUB_ENV
-        echo "VERSION=${TAG#v}" >> $GITHUB_ENV
-        .github/scripts/extract-notes.sh ${VERSION}
     - name: Create GitHub Release
       env:
         GITHUB_TOKEN: ${{ github.token }}
       run: >-
-        gh release create "${TAG}"
-        --repo '${{ github.repository }}'
-        --title "Release ${VERSION}"
+        gh release create "${{ github.ref_name }}"
+        --repo "${{ github.repository }}"
+        --title "Release ${{ github.ref_name }}"
         --notes-file notes.md
     - name: Upload artifact signatures to GitHub Release
       env:
@@ -104,7 +115,8 @@ jobs:
       # sigstore-produced signatures and certificates.
       run: >-
         gh release upload
-        '${{ github.ref_name }}' dist/**
+        "${{ github.ref_name }}"
+        dist/**
         --repo '${{ github.repository }}'
 
   publish-to-testpypi:

stepup-2.0.4/.gitignore

@@ -0,0 +1,19 @@
+# Local dev environment
+.envrc
+.idea
+tmp
+site/
+venv/
+.ruff_cache
+.pytest_cache
+notes.md
+
+# Python and packaging
+__pycache__
+*.egg-info
+dist
+build
+_version.py
+
+# StepUp Core specifics
+docs/.stepup

stepup-2.0.4/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: check-added-large-files
+    - id: check-ast
+    - id: check-case-conflict
+    - id: check-executables-have-shebangs
+    - id: check-json
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-toml
+    - id: check-vcs-permalinks
+    - id: debug-statements
+    - id: detect-private-key
+    - id: destroyed-symlinks
+    - id: end-of-file-fixer
+    - id: fix-byte-order-marker
+    - id: mixed-line-ending
+    - id: pretty-format-json
+      args: ["--autofix", "--no-sort-keys"]
+    - id: trailing-whitespace
+- repo: https://github.com/Lucas-C/pre-commit-hooks
+  rev: v1.5.5
+  hooks:
+    - id: remove-crlf
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.4
+  hooks:
+    - id: ruff-format
+    - id: ruff
+      args: ["--fix", "--show-fixes"]
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.30.0
+  hooks:
+    - id: check-github-workflows

{stepup-2.0.2 → stepup-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: stepup
-Version: 2.0.2
+Version: 2.0.4
 Summary: StepUp Core provides the basic framework for the StepUp build tool
 Author-email: Toon Verstraelen <toon.verstraelen@ugent.be>
 Project-URL: Documentation, https://reproducible-reporting.github.io/stepup-core/

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/amending_static_inputs/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/amending_steps/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/blocked_steps/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/cyclic_dependencies/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run
@@ -24,14 +24,14 @@ Traceback (most recent call last):
         ^^^^^^
     )
     ^
-  File "stepup/core/rpc.py", line 448, in __call__
+  File "stepup/core/rpc.py", line 444, in __call__
     _handle_error(body, name, args, kwargs)
     ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
   File "stepup/core/rpc.py", line 69, in _handle_error
     raise RPCError(f"An exception was raised in the server during the call {fmt_call}: \n\n{body}")
 stepup.core.exceptions.RPCError: An exception was raised in the server during the call step('step:./plan.py', 'cp -aT b.txt a.txt', [Path('b.txt')], [], [Path('a.txt')], [], Path('./'), False, None, False):
 Traceback (most recent call last):
-  File "stepup/core/rpc.py", line 196, in _handle_request
+  File "stepup/core/rpc.py", line 192, in _handle_request
     result = await result
              ^^^^^^^^^^^^
   File "stepup/core/director.py", line 399, in step
@@ -44,12 +44,12 @@ Traceback (most recent call last):
         ^^^^^^^^^^^^
     )
     ^
-  File "stepup/core/workflow.py", line 673, in define_step
+  File "stepup/core/workflow.py", line 699, in define_step
     file.add_supplier(step)
     ~~~~~~~~~~~~~~~~~^^^^^^
   File "stepup/core/file.py", line 135, in add_supplier
     idep = super().add_supplier(supplier)
-  File "stepup/core/cascade.py", line 348, in add_supplier
+  File "stepup/core/cascade.py", line 374, in add_supplier
     raise CyclicError("New relation introduces a cyclic dependency")
 stepup.core.exceptions.CyclicError: New relation introduces a cyclic dependency
 ────────────────────────────────────────────────────────────────────────────────

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/environment_variables/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/here_and_root/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/optional_steps/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/pools/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
   DIRECTOR │ Launched worker 1
@@ -6,18 +6,18 @@
   DIRECTOR │ Launched worker 3
      PHASE │ run
      START │ ./plan.py
+     START │ sleep 0.1; echo A
      START │ sleep 0.1; echo B
    SUCCESS │ ./plan.py
+   SUCCESS │ sleep 0.1; echo A
+─────────────────────────────── Standard output ────────────────────────────────
+A
+────────────────────────────────────────────────────────────────────────────────
    SUCCESS │ sleep 0.1; echo B
 ─────────────────────────────── Standard output ────────────────────────────────
 B
 ────────────────────────────────────────────────────────────────────────────────
-     START │ sleep 0.1; echo A
      START │ sleep 0.1; echo C
-   SUCCESS │ sleep 0.1; echo A
-─────────────────────────────── Standard output ────────────────────────────────
-A
-────────────────────────────────────────────────────────────────────────────────
    SUCCESS │ sleep 0.1; echo C
 ─────────────────────────────── Standard output ────────────────────────────────
 C

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/static_deferred_glob/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/static_named_glob/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/variable_substitution/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/advanced_topics/volatile_outputs/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/changelog.md

@@ -5,10 +5,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased]
 
-(no changes yet)
+(Nothing yet.)
+
+
+## [2.0.4] - 2025-01-28 {: #v2.0.4 }
+
+This release fixes very minor issues. It is mainly for testing release automation.
+
+### Fixed
+
+- Use `importlib.metadata` instead of `_version.py` to get the version number.
+- Add `--version` option to `stepup` command.
+- Improve screen output consistency.
+
+
+## [2.0.3] - 2025-01-27 {: #v2.0.3 }
+
+This release fixes one pesky bug.
+
+### Fixed
+
+- It was previously not possible to reattach an orphaned step to a different creator
+  when this step was not a top-level orphan.
+  This limitation has been lifted, because it is a fully legitimate use case.
+
 
 ## [2.0.2] - 2025-01-25 {: #v2.0.2 }
 
@@ -318,6 +340,8 @@ Initial release
 
 
 [Unreleased]: https://github.com/reproducible-reporting/stepup-core
+[2.0.4]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v2.0.4
+[2.0.3]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v2.0.3
 [2.0.2]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v2.0.2
 [2.0.1]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v2.0.1
 [1.3.1]: https://github.com/reproducible-reporting/stepup-core/releases/tag/v1.3.1

{stepup-2.0.2 → stepup-2.0.4}/docs/development.md

@@ -67,6 +67,7 @@ so you must have it installed on your system.
 ## How to Make a Release
 
 - Mark the release in `docs/changelog.md`.
+  Do not forget to extend the links at the bottom of the file.
 - Make a new commit and tag it with `vX.Y.Z`.
 - Trigger the PyPI GitHub Action: `git push origin main --tags`.
-- Publish a documentation version with `mike deploy {version} -u stable -p`
+- Publish a documentation version with `mike deploy {major.minor} -u stable -p`

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/call/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/copy_mkdir/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
   DIRECTOR │ Launched worker 1
@@ -8,9 +8,9 @@
    SUCCESS │ echo hello > hello.txt
      START │ mkdir -p sub/
    SUCCESS │ mkdir -p sub/
+   SUCCESS │ ./plan.py
      START │ cp -aT hello.txt sub/hello.txt
    SUCCESS │ cp -aT hello.txt sub/hello.txt
-   SUCCESS │ ./plan.py
   DIRECTOR │ Trying to delete 0 outdated output(s).
   DIRECTOR │ Stopping workers.
   DIRECTOR │ See you!

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/dependencies/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
   DIRECTOR │ Launched worker 1

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/distributed_plans/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/first_step/stdout1.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.3.post4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/first_step/stdout2.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.3.post4)
    STARTUP │ Making failed steps pending
    STARTUP │ Watching 1 director(y|ies) from initial database
    STARTUP │ Scanning initial database for changed files

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/no_rules/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/script_multiple/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/script_single/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/static_files/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/static_glob/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/static_glob_conditional/stdout1.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.3.post4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/static_glob_conditional/stdout2.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.3.post4)
    STARTUP │ Making failed steps pending
    STARTUP │ Watching 2 director(y|ies) from initial database
    STARTUP │ Scanning initial database for changed files

{stepup-2.0.2 → stepup-2.0.4}/docs/getting_started/workdir/stdout.txt

@@ -1,4 +1,4 @@
-  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp version 2.0.0)
+  DIRECTOR │ Listening on /tmp/stepup-########/director (StepUp 2.0.4)
    STARTUP │ (Re)initialized boot script
   DIRECTOR │ Launched worker 0
      PHASE │ run

stepup-2.0.4/mkdocs.yaml

@@ -0,0 +1,146 @@
+site_name: StepUp Core
+repo_url: https://github.com/reproducible-reporting/stepup-core
+site_url: https://reproducible-reporting.github.io/stepup-core/
+edit_uri: edit/main/docs/
+site_description: StepUp Core Documentation
+site_author: Toon Verstraelen
+copyright: 2024, Toon Verstraelen
+
+watch:
+  - stepup
+
+strict: true
+validation:
+  nav:
+    omitted_files: warn
+    not_found: warn
+    absolute_links: warn
+  links:
+    not_found: warn
+    anchors: warn
+    absolute_links: warn
+    unrecognized_links: warn
+
+extra:
+  version:
+    provider: mike
+    alias: true
+    default: stable
+
+theme:
+  name: material
+  custom_dir: overrides
+  font:
+    text: IBM Plex Sans
+    code: Source Code Pro
+  features:
+  - search.highlight
+  - search.suggest
+  - search.share
+  - navigation.instant
+  - navigation.instant.prefetch
+  - content.code.copy
+  - content.action.edit
+  palette:
+  - media: "(prefers-color-scheme)"
+    toggle:
+      icon: material/link
+      name: Switch to light mode
+  - media: "(prefers-color-scheme: light)"
+    scheme: default
+    primary: black
+    accent: indigo
+    toggle:
+      icon: material/toggle-switch
+      name: Switch to dark mode
+  - media: "(prefers-color-scheme: dark)"
+    scheme: slate
+    primary: black
+    accent: indigo
+    toggle:
+      icon: material/toggle-switch-off
+      name: Switch to system preference
+
+nav:
+  - Home: index.md
+  - installation.md
+  - Getting started:
+    - getting_started/introduction.md
+    - getting_started/first_step.md
+    - getting_started/dependencies.md
+    - getting_started/static_files.md
+    - getting_started/copy_mkdir.md
+    - getting_started/workdir.md
+    - getting_started/static_glob.md
+    - getting_started/static_glob_conditional.md
+    - getting_started/interactive_usage.md
+    - getting_started/failing_steps.md
+    - getting_started/call.md
+    - getting_started/script_single.md
+    - getting_started/script_multiple.md
+    - getting_started/no_rules.md
+    - getting_started/distributed_plans.md
+    - getting_started/automatic_cleaning.md
+  - Advanced topics:
+    - advanced_topics/introduction.md
+    - advanced_topics/static_named_glob.md
+    - advanced_topics/static_deferred_glob.md
+    - advanced_topics/optional_steps.md
+    - advanced_topics/blocked_steps.md
+    - advanced_topics/pools.md
+    - advanced_topics/environment_variables.md
+    - advanced_topics/volatile_outputs.md
+    - advanced_topics/amending_steps.md
+    - advanced_topics/variable_substitution.md
+    - advanced_topics/here_and_root.md
+    - advanced_topics/cyclic_dependencies.md
+    - advanced_topics/amending_static_inputs.md
+    - advanced_topics/manual_cleaning.md
+    - advanced_topics/stepup_root.md
+    - advanced_topics/step_info.md
+  - Reference:
+    - reference/stepup.core.api.md
+    - reference/stepup.core.interact.md
+    - reference/stepup.core.nglob.md
+    - reference/stepup.core.stepinfo.md
+    - reference/interactive.md
+    - reference/environment_variables.md
+  - changelog.md
+  - development.md
+  - license.md
+
+exclude_docs: |
+  */*/ch*/*.md
+  */*/public/*.md
+
+plugins:
+- mike
+- search:
+    lang:
+      - en
+- macros:
+    on_error_fail: true
+    on_undefined: strict
+- mkdocstrings:
+    default_handler: python
+    handlers:
+      python:
+        paths: ["stepup-core"]
+        options:
+          docstring_style: numpy
+          show_root_heading: true
+          docstring_section_style: list
+
+markdown_extensions:
+  - admonition
+  - attr_list
+  - smarty
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - toc:
+      permalink: true