Skip to content

Add simulation extraction and viewing notebook #122

Add simulation extraction and viewing notebook

Add simulation extraction and viewing notebook #122

name: Test OpenFE Docs Build
on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main
schedule:
# nightly tests, 2 am
- cron: "0 2 * * *"
concurrency:
group: "${{ github.workflow }}-${{ github.ref }}"
cancel-in-progress: true
defaults:
run:
shell: bash -leo pipefail {0}
jobs:
test-openfe-docs-build:
runs-on: ubuntu-latest
steps:
- name: Checkout openfe
uses: actions/checkout@v4
with:
repository: OpenFreeEnergy/openfe
path: openfe
- name: Checkout ExampleNotebooks repository
uses: actions/checkout@v4
with:
path: openfe/docs/ExampleNotebooks
- name: Get current date
id: date
run: echo "date=$(date +%Y-%m-%d)" >> "${GITHUB_OUTPUT}"
- name: Install doc environment
uses: mamba-org/setup-micromamba@v2
with:
environment-file: openfe/docs/environment.yaml
cache-environment: true
cache-downloads: true
cache-environment-key: environment-${{ steps.date.outputs.date }}
cache-downloads-key: downloads-${{ steps.date.outputs.date }}
init-shell: bash
- name: Build the docs
run: |
cd openfe
# install so that we can get a version metadata we use in docs
pip install . --no-deps
cd docs
make html