docs.yml

name: Docs

on:
  workflow_dispatch:
  push:
    branches:
      - master
      - v*

jobs:
  deploy-documentation:

    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Set up Python 3.10
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"

    - name: Install requirements
      run: |
        sudo apt-get update -y
        sudo apt-get install graphviz -y
        python -m pip install --upgrade pip
        python -m pip install -r requirements.txt
        python -m pip install -r requirements_developers.txt

    - name: Generate diagrams
      run: python docs/fsm/graphviz/draw_state_diagrams.py

    - name: Build documentation
      uses: ammaraskar/sphinx-action@master
      with:
        docs-folder: docs/
        pre-build-command: |
          mkdir -p docs/build/
          touch docs/build/.nojekyll
          python -m pip install -r requirements_developers.txt
        build-command: sphinx-build -b html . build

    - name: Deploy documentation
      uses: JamesIves/github-pages-deploy-action@v4.5.0
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages
        folder: docs/build