Kumi
4f3159b3fa
Some checks failed
website / build (push) Failing after 27s
Simplified the Python dependency installation process within the pdoc workflow by combining multiple pip install commands into a single instruction. This reduces the number of steps and makes the workflow more efficient. The update also includes the removal of unnecessary comments and unused dependency installation commands, making the YAML file cleaner and easier to understand. This change could potentially speed up the documentation generation process by reducing the overall runtime of the workflow.
36 lines
820 B
YAML
36 lines
820 B
YAML
name: website
|
|
|
|
# build the documentation whenever there are new commits on main
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
# Alternative: only build for tags.
|
|
# tags:
|
|
# - '*'
|
|
workflow_dispatch:
|
|
## security: restrict permissions for CI jobs.
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
# Build the documentation and upload the static HTML files as an artifact.
|
|
build:
|
|
container:
|
|
image: node:20-bookworm
|
|
steps:
|
|
- name: Install dependencies
|
|
run: |
|
|
apt update
|
|
apt install -y python3 python3-pip
|
|
|
|
- name: Install Python dependencies
|
|
run: |
|
|
pip install pdoc requests --break-system-packages
|
|
|
|
- run: python3 -m pdoc -d markdown -o docs src/plankapy/plankapy.py
|
|
|
|
- uses: forgejo/upload-artifact@v4
|
|
with:
|
|
path: docs
|
|
|