Feature/flow system first

.github/workflows/docs.yaml

@@ -0,0 +1,108 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'flixopt/**'
+  pull_request:
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+  workflow_dispatch:
+  workflow_call:
+    inputs:
+      deploy:
+        type: boolean
+        default: false
+      version:
+        type: string
+        required: false
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: "3.11"
+  MPLBACKEND: Agg
+  PLOTLY_RENDERER: json
+
+jobs:
+  build:
+    name: Build documentation
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.9.10"
+          enable-cache: true
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Extract changelog
+        run: |
+          cp CHANGELOG.md docs/changelog.md
+          python scripts/format_changelog.py
+
+      - name: Install dependencies
+        run: uv pip install --system ".[docs,full]"
+
+      - name: Build docs
+        run: mkdocs build --strict
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: site/
+          retention-days: 7
+
+  deploy:
+    name: Deploy documentation
+    needs: build
+    if: ${{ inputs.deploy == true && inputs.version != '' }}
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.9.10"
+          enable-cache: true
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install mike
+        run: uv pip install --system mike
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: site/
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy docs
+        run: |
+          VERSION=${{ inputs.version }}
+          VERSION=${VERSION#v}
+          mike deploy --push --update-aliases --no-build $VERSION latest
+          mike set-default --push latest

.github/workflows/release.yaml

@@ -80,7 +80,7 @@ jobs:
     name: Run tests
     needs: [check-preparation]
     if: needs.check-preparation.outputs.prepared == 'true'
-    uses: ./.github/workflows/test.yaml
+    uses: ./.github/workflows/tests.yaml
 
   build:
     name: Build package
@@ -188,37 +188,7 @@ jobs:
     name: Deploy documentation
     needs: [create-release]
     if: "!contains(github.ref, 'alpha') && !contains(github.ref, 'beta') && !contains(github.ref, 'rc')"
-    runs-on: ubuntu-24.04
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v5
-        with:
-          fetch-depth: 0
-
-      - uses: astral-sh/setup-uv@v6
-        with:
-          version: "0.9.10"
-
-      - uses: actions/setup-python@v6
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - name: Extract changelog
-        run: |
-          uv pip install --system packaging
-          python scripts/extract_changelog.py
-
-      - name: Install docs dependencies
-        run: uv pip install --system ".[docs]"
-
-      - name: Configure Git
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-
-      - name: Deploy docs
-        run: |
-          VERSION=${GITHUB_REF#refs/tags/v}
-          mike deploy --push --update-aliases $VERSION latest
-          mike set-default --push latest
+    uses: ./.github/workflows/docs.yaml
+    with:
+      deploy: true
+      version: ${{ github.ref_name }}

.github/workflows/test.yaml → .github/workflows/tests.yaml

@@ -4,9 +4,9 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: ["*"]
+    branches: ["**"]
   workflow_dispatch:
-  workflow_call:  # Allow release.yaml to call this workflow
+  workflow_call:  # Allow release.yaml to call this workflow.
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -45,7 +45,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.11', '3.12', '3.13', '3.14']
     steps:
       - uses: actions/checkout@v5
 

.gitignore

@@ -8,3 +8,7 @@ venv/
 .DS_Store
 lib/
 temp-plot.html
+.cache
+site/
+*.egg-info
+uv.lock

.pre-commit-config.yaml

@@ -7,10 +7,17 @@ repos:
       - id: check-yaml
         exclude: ^mkdocs\.yml$  # Skip mkdocs.yml
       - id: check-added-large-files
+        exclude: ^examples/resources/Zeitreihen2020\.csv$
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.4
     hooks:
-    - id: ruff-check
-      args: [ --fix ]
-    - id: ruff-format
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.8.2
+    hooks:
+      - id: nbstripout
+        files: ^docs/examples.*\.ipynb$