Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/ymyke/tessa
Browse files Browse the repository at this point in the history
  • Loading branch information
ymyke committed Sep 30, 2022
2 parents 1769707 + f42a21b commit b12e79f
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/pdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: pdoc

# build the documentation whenever there are new commits on main
on:
push:
branches:
- master
# 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@v3

# ADJUST THIS: install all dependencies (including pdoc)
- run: pip install -r requirements.txt
# 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 -t docs/pdoc-dark-mode tessa

- 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@v1

0 comments on commit b12e79f

Please sign in to comment.