This commit is contained in:
hwelch-fle 2023-05-01 14:45:21 -04:00
commit 758417a19a
2 changed files with 51 additions and 0 deletions

49
.github/workflows/pdoc.yml vendored Normal file
View file

@ -0,0 +1,49 @@
name: website
# build the documentation whenever there are new commits on main
on:
push:
branches:
- main
# 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.11'
# ADJUST THIS: install all dependencies (including pdoc)
- run: pip install -e .
# 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/ ...
- 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@v2

View file

@ -1,2 +1,4 @@
# plankapy # plankapy
A python 3 based API for controlling a self-hosted Planka instance A python 3 based API for controlling a self-hosted Planka instance
[Docs](https://hwelch-fle.github.io)