sphinx-python-dependency-build-checks.yml

# The purpose of this workflow file is to confirm that the Sphinx
# virtual environment can be built from source, consequently documenting
# the packages required in the build environment to do that.
#
# This is needed because some projects embeds the documentation into built
# artifacts which involves rendering the documentation on the target
# architecture.
#
# Depending on the architecture, pip may or may not have already built wheels
# available, and as such we need to make sure building wheels from source can
# succeed.
name: Check and document build requirements for Sphinx venv
on:
  - push
  - pull_request
  - workflow_dispatch

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: build
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install dependencies
        run: |
          set -ex
          sudo apt -y install \
            cargo \
            libpython3-dev \
            libxml2-dev \
            libxslt1-dev \
            make \
            python3-venv \
            rustc
      - name: Build Sphinx venv
        working-directory: "docs"
        run: |
          set -ex
          make -f Makefile.sp \
            sp-install \
            PIPOPTS="--no-binary :all:" \
            || ( cat .sphinx/venv/pip_install.log && exit 1 )