build.yaml

name: Build

on:
  pull_request:
    branches: [main]
  workflow_dispatch:
    inputs:
      debug_enabled:
        type: boolean
        description: Debug with tmate
        required: false
        default: false

jobs:
  docs:
    runs-on: ubuntu-22.04

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Fetch all tags and branches
        run: git fetch --prune --unshallow

      - name: Create ArangoDB Docker container
        run: >
          docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd -v "$(pwd)/tests/static/":/tests/static
          arangodb/arangodb:3.10.10 --server.jwt-secret-keyfile=/tests/static/keyfile

      - name: Start ArangoDB Docker container
        run: docker start arango

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      - name: Debug with tmate
        uses: mxschmitt/action-tmate@v3
        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}

      - name: Run pre-commit checks
        uses: pre-commit/action@v3.0.0

      - name: Install dependencies
        run: pip install .[dev]

      - name: Run Sphinx doctest
        run: python -m sphinx -b doctest docs docs/_build

      - name: Generate Sphinx HTML
        run: python -m sphinx -b html -W docs docs/_build