documentation.yaml

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

name: Documentation

on:
    push:
        branches:
            - 3.x
            - master
    pull_request:

env:
    ACTIONS_ALLOW_UNSECURE_COMMANDS: true

jobs:
    build:
        name: Sphinx build

        runs-on: ubuntu-latest

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

            - name: Set up Python 3.7
              uses: actions/setup-python@v2
              with:
                  python-version: '3.7'

            - name: Display Python version
              run: python -c "import sys; print(sys.version)"

            - name: Cache pip
              uses: actions/cache@v2
              with:
                  path: ~/.cache/pip

                  key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
                  restore-keys: ${{ runner.os }}-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@v2

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