docs.yml

name: Documentation

on:
    push:
        paths:
            - "docs/**"
            - "AUTHORS.rst"
            - "CITATION.rst"
            - "CODE-OF-CONDUCT.rst"
            - "CONTRIBUTING.rst"
            - "README.rst"
    pull_request:
        paths:
            - "docs/**"
            - "AUTHORS.rst"
            - "CITATION.rst"
            - "CODE-OF-CONDUCT.rst"
            - "CONTRIBUTING.rst"
            - "README.rst"

jobs:
    build-docs:
        # We want to run on external PRs, but not on our own internal PRs as they'll be run
        # by the push to the branch. Without this if check, checks are duplicated since
        # internal PRs match both the push and pull_request events.
        if:
          github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
          github.repository

        runs-on: ubuntu-latest

        steps:
          - uses: actions/checkout@v4
          - uses: actions/setup-python@v5

          - name: Install dependencies
            run: pip install nox

          - name: Check for lint
            run: nox -s lint

          - name: Build documentation
            run: nox -s build-docs