Skip to content

Build docs

Build docs #111

Workflow file for this run

name: Build docs
on:
pull_request:
branches: [main]
push:
branches: [main]
schedule:
- cron: "0 0 * * *"
permissions:
contents: read
pull-requests: write
jobs:
build_docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Install uv
uses: astral-sh/setup-uv@v7
- name: Set up Python
run: uv python install 3.11
- name: Install fmu-dataio
run: |
if [ "${{ github.event_name }}" = "schedule" ]; then
uv sync --all-extras --upgrade
else
uv sync --all-extras --frozen
fi
# Install repos from their Github main branches instead of Pypi.
# This removes the need to manually pin these version of the repos
# during the development phase.
- name: Install fmu-datamodels
run: |
git clone https://github.com/equinor/fmu-datamodels ../fmu-datamodels
uv pip install ../fmu-datamodels
- name: Generate updated examples
run: uv run sh examples/update_examples.sh
- name: Build documentation with sphinx
run: uv run sphinx-build -b html docs/src build/docs/html -j auto