docs.yml

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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Install uv
        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0

      - 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