Several suggested changes to the documentation #112
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
#Old version from when we didn't need geant4 for the docs: | |
# - name: Setup conda environment | |
# uses: conda-incubator/setup-miniconda@v2 | |
# with: | |
# activate-environment: publish-doc-condaenv | |
# environment-file: .github/resources/publish-doc-condaenv.yml | |
# #use-mamba: no | |
# | |
#Since we need geant4 for the docs, we use the smart 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 . | |
python3 -c 'import matplotlib' | |
python3 -c 'import matplotlib.pyplot' | |
#NB: import matplotlib.pyplot is also to ensure the font cache is | |
#triggered, so we don't get output in the middle of our unit tests | |
#later.. | |
- name: Build documentation | |
#NB: -W to turn warnings into errors: | |
run: make html SPHINXOPTS="-W" | |
working-directory: ./doc/ |