Skip to content

enhancement #37: generate doc with pdoc #4

enhancement #37: generate doc with pdoc

enhancement #37: generate doc with pdoc #4

Workflow file for this run

name: Generate Python Documentation
on: [pull_request]
jobs:
check-docstrings:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"
cache: 'pip' # caching pip dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[dev]
- name : Check docstrings
run : pydocstyle src/ --convention google --count
build-docs:
runs-on: ubuntu-22.04
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install .[dev]
- name: Generate Documentation
run: pdoc example --output-dir docs
- name: Archive Documentation
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/