Skip to content

add ODIM_H5 format description, data and notebooks #17

add ODIM_H5 format description, data and notebooks

add ODIM_H5 format description, data and notebooks #17

Workflow file for this run

name: Docs Build (MyST-NB + RTD Mirror)
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build-docs:
name: Build and Test Documentation
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: [ "3.13" ]
defaults:
run:
shell: bash -l {0}
env:
CONDA_ENV_FILE: environment.yml
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install micromamba environment
uses: mamba-org/setup-micromamba@v2
with:
environment-name: radolan-guide
environment-file: environment.yml
cache-environment: true
cache-environment-key: "${{runner.os}}-${{runner.arch}}-py${{env.PYTHON_VERSION}}-${{env.TODAY}}-${{hashFiles(env.CONDA_ENV_FILE)}}"
create-args: >-
python=${{matrix.python-version}}
- name: pytest notebooks
working-directory: notebooks
run: |
pytest -v -n auto
- name: Build documentation with Sphinx
run: |
python -m sphinx -j 14 -b html . _build/html -v
- name: Upload HTML build (for PR inspection)
if: ${{ success() }}
uses: actions/upload-artifact@v4
with:
name: docs-html
path: _build/html