test-doc.yml

name: build-docs
on:
  push:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -el {0}
    env:
      CONDA_SOLVER: libmamba

    steps:
    - name: Checkout main repository
      uses: actions/checkout@v4

     #Since we need geant4 for the docs, we use the geant-data cache method from
     #condatest.yml, and then update afterwards:
    - name: Setup conda environment
      uses: ./.github/actions/setup
      with:
        PYTHON_VERSION: 3.11
        USE_MAMBA: true
        CACHED_NOARCH_DEF_PY_FILE: ./.github/resources/cached_noarch_definitions.py
        CONDA_ENV_FILE : ./.github/resources/conda-setup.yml

    - name: Update conda env for docs
      #NB: We do NOT add --prune in the next link, since
      #conda-setup_extra_for_docs.yml only contains the extra dependencies
      run: conda env update --name simplebuild_dgcode --file ./.github/resources/conda-setup_extra_for_docs.yml

    - name: Install self
      run: python3 -mpip install .

    - name: Build documentation
      #NB: -W to turn warnings into errors:
      run: make html SPHINXOPTS="-W"
      working-directory: ./doc/

    - name: Check HTML links
      run: make linkcheck
      working-directory: ./doc/