Skip to content

ci: add workflow to build and deploy docs ad gh page #1

ci: add workflow to build and deploy docs ad gh page

ci: add workflow to build and deploy docs ad gh page #1

Workflow file for this run

# 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:
- dev
# 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'
# Install all dependencies (including pdoc)
- run: pip install -e .[docs]
- run: pdoc -d numpy -o docs tensorflow_time_series_dataset
- 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