Skip to content

[pre-commit.ci] pre-commit autoupdate (#47) #77

[pre-commit.ci] pre-commit autoupdate (#47)

[pre-commit.ci] pre-commit autoupdate (#47) #77

Workflow file for this run

name: Docs
on:
# Run build & publish on pushes targeting the default branch (after PR is merged)
push:
branches:
- main
# Run build during PRs (but not publish)
pull_request:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
# Checkout code and setup miniconda with test dependencies
- uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3
- uses: conda-incubator/setup-miniconda@3b0f2504dd76ef23b6d31f291f4913fb60ab5ff3 # v2
with:
miniconda-version: latest
channels: conda-forge
activate-environment: docs-env
environment-file: docs/environment.yml
auto-activate-base: false
- name: Build Documentation
run: |
make -C docs html
- name: Upload artifact
uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2
with:
path: 'docs/_build/html'
pages:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: [docs]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@12ab2b16cf43a7a061fe99da74b6f8f11fb77f5b # v2