docs.yml

name: Deploy docs to Pages

on:
  push:
    branches:
      - dev
    paths:
      - '**.rst'
      - 'conf.py'
      - '_version.py'
      - 'vne/**'

  workflow_dispatch:
  release:
    types: [published]  # Triggered when a release is published (not draft)

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

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    name: build docs
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-node@v4
      with:
        node-version: 18

    - uses: actions/setup-python@v5
      with:
        python-version: 3.11

    - name: Install deps
      run: python -m pip install -r ./requirements.txt

    - name: Build docs
      run: sphinx-build -b dirhtml -E -a ./sphinx/source ./docs
      env:
        USE_DOCSEARCH: True

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
          path: docs/

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    needs: build

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4