Add documentation publish and preview workflows #1
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate Python Documentation | |
on: | |
push: | |
branches: | |
- main | |
pull_request: {} | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Set up Poetry | |
uses: Gr1N/setup-poetry@v8 | |
with: | |
poetry-version: "1.7.1" | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
cache: 'poetry' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install pdoc3 | |
- name: Generate documentation | |
run: | | |
pdoc --html --output-dir docs . |