Skip to content

build and deploy docs #34

build and deploy docs

build and deploy docs #34

Workflow file for this run

name: build and deploy docs
# build the documentation whenever there are new commits on main
on:
workflow_run:
workflows: ["build and test GPU"]
branches:
- master
types:
- completed
# 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@v3
- uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Add conda to system path
run: |
# $CONDA is an environment variable pointing to the root of the miniconda directory
echo $CONDA/bin >> $GITHUB_PATH
- name: Install dependencies
run: |
conda env update --file conda/pp-gpu.yml --name base
- name: Install package
run: $CONDA/bin/pip install -e .
- name: Build docs
run: |
export LD_LIBRARY_PATH=$CONDA/lib/:$LD_LIBRARY_PATH
export PDOC_ALLOW_EXEC=1
$CONDA/bin/pdoc -o docs/ basketballtrainer
- 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