Skip to content

prsess-docs

prsess-docs #2

Workflow file for this run

# adapted from https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml
name: prsess-docs
on:
workflow_dispatch:
# 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:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.11'
# install all dependencies (including pdoc)
- run: pip install pyrsess pdoc numpy
# build documentation into docs/
- run: pdoc pyrsess -o docs/
- uses: actions/upload-pages-artifact@v2
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:
- id: deployment
uses: actions/deploy-pages@v2