Skip to content

Feature/testing and docs #39

Feature/testing and docs

Feature/testing and docs #39

Workflow file for this run

# Python Auto Documentation
# This workflow auto-generates documentation using Sphinx
name: Python Auto Documentation
permissions:
contents: read
on:
push:
paths:
- '**.py'
pull_request:
paths:
- '**.py'
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Setup Python Environment
uses: ./.github/actions/setup-python-env
with:
python-version: '3.11'
install-dev-reqs: 'false'
install-docs-reqs: 'true'
- name: Generate Sphinx docs
run: |
sphinx-apidoc -o docs/ src/
sphinx-build -b html docs/ docs/_build/html
- name: Upload documentation artifact
uses: actions/upload-artifact@v4
with:
name: sphinx-docs
path: docs/_build/html