reusable-sphinx-build.yml

name: Build Sphinx documentation 📖

on:
  push:
    branches:
      - dev

# ----------------------------------------------------------------------------------------------------------------------

defaults:
  run:
    shell: bash
    working-directory: .

jobs:
  test-and-build:
    name: Build Sphinx documentation
    runs-on: ubuntu-20.04

    steps:

      - name: Checkout 🛎
        uses: actions/checkout@v3

      # ----------------------------------------------------------------------------------------------------------------

      - name: Install PyCRAM dependencies 🍼
        uses: py-actions/py-dependency-install@v4
        with:
          path: "requirements.txt"

      # ----------------------------------------------------------------------------------------------------------------
      - name: Install Sphinx dependencies 📚
        uses: py-actions/py-dependency-install@v4
        with:
          path: "doc/requirements.txt"

      # ----------------------------------------------------------------------------------------------------------------
      - name: Build Sphinx documentation 📝
        working-directory: ./doc
        run: |
          sudo apt install pandoc
          make html