pages.yml

name: GitHub Pages

permissions:
  contents: read
  pages: write
  id-token: write

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
  release:
    types:
      - published

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    container: containers.ligo.org/lscsoft/bilby/v2-bilby-python311
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          fetch-tags: true
      - name: install
        run: python -m pip install .
      - name: Run jupyter notebooks
        run: |
          python -m ipykernel install
          cd examples/tutorials
          jupyter nbconvert --to notebook --execute *.ipynb --output-dir ../../docs
          cd -
      - name: Build docs
        run: |
          cd docs
          make clean
          make html
          cd -
      # Upload the build docs as an artifact until we expose the pages
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html/
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4