Skip to content

Commit

Permalink
ci: add gh worklfow for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MArpogaus committed Jul 12, 2024
1 parent 66d38d5 commit fb12483
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Adjusted workflow from: https://github.com/mitmproxy/pdoc/blob/25f325d06aaacba9711f957f48e770029f608f6a/.github/workflows/docs.yml

name: Generate documentation using pdoc and deploy as gh page.

# build the documentation whenever there are new commits on main
on:
push:
branches:
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.11'

# Install all dependencies (including pdoc)
- run: pip install -e .[docs]
- run: pdoc -d numpy -o docs bernstein_flow
- uses: actions/upload-pages-artifact@v3
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@v4

0 comments on commit fb12483

Please sign in to comment.