plankapy/.github/workflows/pdoc.yml

51 lines
1.3 KiB
YAML
Raw Normal View History

2023-05-01 18:42:16 +00:00
name: website
# build the documentation whenever there are new commits on main
2023-05-01 18:50:15 +00:00
on: workflow_dispatch
#on:
# push:
# branches:
# - main
# # Alternative: only build for tags.
# # tags:
# # - '*'
#
## security: restrict permissions for CI jobs.
2023-05-01 18:42:16 +00:00
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'
# ADJUST THIS: install all dependencies (including pdoc)
- run: pip install -e .
# ADJUST THIS: build your documentation into docs/.
# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
- run: pdoc -o docs/ ...
2023-05-01 18:42:16 +00:00
- uses: actions/upload-pages-artifact@v1
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