Skip to content

added docs generation and reformatted code #4

added docs generation and reformatted code

added docs generation and reformatted code #4

Workflow file for this run

name: website
# build the documentation whenever there are new commits on main
on:
push:
branches:
- main
# 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'
- uses: abatilo/actions-poetry@v2
# ADJUST THIS: install all dependencies (including pdoc)
- run: pip install -r requirements.txt
- run: pip install pdoc
# 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/ src/client.py src/server.py src/services.py src/transport_message.py
- 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
steps:
- id: deployment
uses: actions/deploy-pages@v2