Skip to content

Commit

Permalink
chore: add docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
hrz6976 committed Jun 13, 2024
1 parent 9f7a9fe commit 10e5443
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Generate docs

on: [push]

jobs:
generate-docs:
name: Docs
runs-on: ubuntu-latest
# only on default branch
if: github.ref_name == github.event.repository.default_branch

steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Install Poetry
run: |
PIPX_BIN_DIR=/usr/local/bin pipx install poetry
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.8"
cache: poetry
cache-dependency-path: poetry.lock

- name: Generate docs with pdoc
run: |
cd docs
poetry run pdoc --output-dir . --favicon ./favicon.ico ../woc
- name: Upload generated docs
uses: actions/upload-artifact@v2
with:
name: docs
path: docs/*

0 comments on commit 10e5443

Please sign in to comment.