Skip to content

add options for upwind and minmod, used by Amr-Wind #840

add options for upwind and minmod, used by Amr-Wind

add options for upwind and minmod, used by Amr-Wind #840

Workflow file for this run

name: Build and Deploy Docs
on: [push, pull_request]
concurrency:
group: ${{ github.ref }}-${{ github.head_ref }}-docs
cancel-in-progress: true
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Dependencies
run: |
.github/workflows/dependencies/documentation.sh
echo "Installing python packages for docs..."
pip install breathe sphinx sphinx_rtd_theme sphinxcontrib.bibtex
pip install docutils
pip install sphinx-toolbox
- name: Build Doxygen Docs
run: |
./build_doxygen_docs.sh
- name: Install and Build
run: |
cd Docs
echo "Build the Sphinx documentation for AMReX-Hydro."
## build latex pdf -- disabled due to conflict with predefined math expressions in rst files
#make latexpdf
#mv build/latex/amrex-hydro.pdf source/
make html
- name: Deploy
if: github.event_name == 'push' && github.repository == 'AMReX-Fluids/AMReX-Hydro' && github.ref == 'refs/heads/development'
uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ACCESS_TOKEN: ${{ secrets.DEPLOY_DOCS_HYDRO }}
REPOSITORY_NAME: AMReX-Fluids/AMReX-Fluids.github.io
BRANCH: main # The branch the action should deploy to.
FOLDER: Docs/build/html # The folder the action should deploy.
TARGET_FOLDER: amrex-hydro/docs_html # The folder the action should deploy to.
CLEAN: false # Do not remove existing files from the deploy target.
- name: Deploy Doxygen
if: github.event_name == 'push' && github.repository == 'AMReX-Fluids/AMReX-Hydro' && github.ref == 'refs/heads/development'
uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ACCESS_TOKEN: ${{ secrets.DEPLOY_DOCS_HYDRO }}
REPOSITORY_NAME: AMReX-Fluids/AMReX-Fluids.github.io
BRANCH: main # The branch the action should deploy to.
FOLDER: Docs/Doxygen/html # The folder the action should deploy.
TARGET_FOLDER: amrex-hydro/Doxygen/html # The folder the action should deploy to.
CLEAN: false # Do not remove existing files from the deploy target.