test_and_doc.yml

name: Docs and tests

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Set up Python 3.9
        uses: actions/setup-python@v3
        with:
          python-version: "3.9"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: Run tests
        run: |
          pytest --html=build/tests/index.html --self-contained-html -vv

      - name: Generate documentation
        run: |
          cd docs/
          make html
          cd ..

      - name: Move doc to build folder
        run: |
          mkdir -p build/docs
          mv docs/_build/html/* build/docs/

      - name: Upload GitHub Pages artifact
        if: always()
        uses: actions/upload-pages-artifact@v1.0.7
        with:
          path: build/

  deploy:
    needs: build

    permissions:
      pages: write
      id-token: write

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

    runs-on: ubuntu-latest
    steps:
      - name: Deploy GitHub Pages site
        if: always()
        id: deployment
        uses: actions/deploy-pages@v1.2.2