Skip to content

docs(MpoOptimizer): expand module/class docstrings and inline comments #56

docs(MpoOptimizer): expand module/class docstrings and inline comments

docs(MpoOptimizer): expand module/class docstrings and inline comments #56

Workflow file for this run

name: CI
on:
push:
branches: [main, develop]
pull_request:
jobs:
test:
runs-on: ubuntu-latest
env:
NUMBA_CACHE_DIR: /tmp/numba_cache_pepsy
PYTHONPYCACHEPREFIX: /tmp/pycache_pepsy
MPLCONFIGDIR: /tmp/mplconfig_pepsy
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install package
run: |
python -m pip install --upgrade pip
pip install -e .[dev]
- name: Validate source syntax
run: python -m compileall -q -f src tests
- name: Check Python lint
run: python -m pyflakes src/pepsy tests
- name: Run tests
run: pytest -q
docs:
runs-on: ubuntu-latest
env:
NUMBA_CACHE_DIR: /tmp/numba_cache_pepsy
PYTHONPYCACHEPREFIX: /tmp/pycache_pepsy
MPLCONFIGDIR: /tmp/mplconfig_pepsy
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install docs deps
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Build docs
run: sphinx-build -W -b html docs docs/_build/html