Skip to content

adding path to upload-pages-artifact #39

adding path to upload-pages-artifact

adding path to upload-pages-artifact #39

Workflow file for this run

name: documentation
# build the documentation whenever there are new commits on main
on:
push:
tags:
- "*"
branches:
- main
# security: restrict permissions for CI jobs.
permissions:
contents: read
jobs:
# Build the documentation and upload the static HTML files as an artifact.
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: pip install pdoc
- run: pip install -e .
- name: Build documentation
run: python scripts/make_docs.py
- name: Upload documentation
uses: actions/upload-artifact@v4
with:
path: docs/
# Deploy the artifact to GitHub pages.
# This is a separate job so that only actions/deploy-pages has the necessary permissions.
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Configure Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: .
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4