Skip to content
docs build

name variables to geom when its amrex::Geometry to avoid confusion in Derive.H/.cpp #2422

Sign in to view logs

name variables to geom when its amrex::Geometry to avoid confusion in Derive.H/.cpp

name variables to geom when its amrex::Geometry to avoid confusion in Derive.H/.cpp #2422

Workflow file for this run

.github/workflows/docs-test.yml at ac9568b
name: docs build
on:
push:
branches:
- development
- main
pull_request:
branches:
- development
env:
# enable color output from Sphinx
FORCE_COLOR: "1"
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install pandoc and doxygen
run: |
sudo apt install pandoc doxygen
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: "pip"
- name: Install dependencies
run: pip install -r ./requirements.txt
- name: Build docs
run: |
cd Docs/
# remove missing TOC entries that would otherwise be generated by
# doxygen to avoid warnings about missing references
sed -i -e 's/^ filelist$//; s/^ classlist$//' source/index.rst
make SPHINXOPTS='-v -W --keep-going' NO_DOXYGEN=TRUE html
- name: Check links
run: |
cd Docs/
make SPHINXOPTS=-v NO_DOXYGEN=TRUE linkcheck