Skip to content

chore: include logo in generated docs #4

chore: include logo in generated docs

chore: include logo in generated docs #4

Workflow file for this run

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: Set Poetry environment
run: |
poetry env use 3.8
- name: Install dependencies
run: |
poetry install
- name: Generate docs with pdoc
run: |
cd docs
poetry run pdoc --output-dir . --favicon /favicon.ico --logo /woc.png ../woc
- name: Upload generated docs
uses: actions/upload-artifact@v2
with:
name: docs
path: docs/*