Skip to content

consolidated: move test_results and apply small ruff fixes (#27) #21

consolidated: move test_results and apply small ruff fixes (#27)

consolidated: move test_results and apply small ruff fixes (#27) #21

Workflow file for this run

# Python Auto Documentation
# This workflow auto-generates documentation using Sphinx
name: Python Auto Documentation
on:
push:
paths:
- '**.py'
pull_request:
paths:
- '**.py'
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-autodoc-typehints
- 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