Skip to content

Deploy Documentation to Pages #16

Deploy Documentation to Pages

Deploy Documentation to Pages #16

Workflow file for this run

name: Deploy Documentation to Pages
on:
push:
branches: ["main"]
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Miniconda
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: po3
channels: conda-forge,defaults
auto-update-conda: true
environment-file: docs-environment.yml
- name: Install PyORBIT3
shell: bash -l {0}
run: |
# @woodtp -- MPI isn't required to build docs and enabling it causes Sphinx to segfault.
conda activate po3
pip install --config-settings=setup-args="-DUSE_MPI='none'" .
- name: Build Documentation
shell: bash -l {0}
run: |
conda activate po3
cd doc
make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './doc/build/html'
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4