Skip to content

Merge pull request #11 from USEPA/plotting #3

Merge pull request #11 from USEPA/plotting

Merge pull request #11 from USEPA/plotting #3

name: Generate Docs Website
# build the documentation whenever there are new commits on main
on:
push:
branches:
- main
paths:
- pybeepop/**
- .github/workflows/generate-docs-site.yml
# Alternative: only build for tags.
# tags:
# - '*'
# 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@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
# ADJUST THIS: install all dependencies (including pdoc)
- run: pip install pdoc3 pandas
# 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 --html --skip-errors -o docs/ pybeepop
- uses: actions/upload-pages-artifact@v3
with:
path: docs/pybeepop/
# 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@v4