Skip to content

[pre-commit.ci] pre-commit autoupdate (#723) #374

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

[pre-commit.ci] pre-commit autoupdate (#723) #374

Workflow file for this run

name: Docs
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
pull_request:
paths:
- ".github/workflows/docs.yml"
- "docs/**"
- "CONSTRUCT.md"
- "constructor/construct.py"
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow one concurrent deployment
concurrency:
group: pages-${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
jobs:
docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@v3
- uses: conda-incubator/setup-miniconda@v2
with:
activate-environment: constructor-docs
environment-file: docs/environment.yml
python-version: '3.11'
auto-activate-base: false
- name: Build Documentation
run: |
cd docs
make dirhtml
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: 'docs/_build/dirhtml'
pages:
runs-on: ubuntu-latest
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
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@v1