docs.yml

name: Documentation building
on:
  schedule:
    - cron: '0 0 * * 2'
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
    paths:
      - .github/workflows/docs.yml
      - "atom/**"
      - "docs/**"
      - "examples/**"
      - setup.py
      - pyproject.toml

jobs:
  docs:
    name: Docs building
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Get history and tags for SCM versioning to work
        run: |
          git fetch --prune --unshallow
          git fetch --depth=1 origin +refs/tags/*:refs/tags/*
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt
      - name: Install project
        run: |
          pip install .
      - name: Install graphviz
        uses: ts-graphviz/setup-graphviz@v1
      - name: Build documentation
        # Remove -W till the multiple reference can be fixed in Sphinx 4
        run: |
          mkdir docs_output;
          sphinx-build docs/source docs_output -b html;