documentation.yaml

# DO NOT EDIT THIS FILE!
#
# It's auto-generated by sonata-project/dev-kit package.

name: Documentation

on:
    push:
        branches:
            - master
    pull_request:

permissions:
    contents: read

jobs:
    build:
        name: Sphinx build

        runs-on: ubuntu-latest

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

            - name: Set up Python 3.11
              uses: actions/setup-python@v5
              with:
                  python-version: '3.11'
                  cache: 'pip'

            - name: Install custom requirements via pip
              run: pip install -r docs/requirements.txt

            - name: Build documentation
              run: make docs

    doctor-rst:
        name: DOCtor-RST

        runs-on: ubuntu-latest

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

            - name: Run DOCtor-RST
              uses: docker://oskarstark/doctor-rst
              with:
                  args: --short --error-format=github
              env:
                  DOCS_DIR: docs/