Skip to content

Refactor project for JOSS-ready packaging with CI, docs, and ReadMe #2

Refactor project for JOSS-ready packaging with CI, docs, and ReadMe

Refactor project for JOSS-ready packaging with CI, docs, and ReadMe #2

Workflow file for this run

# ...
# Copyright 2021 Brooks M. Musangu and Jan Drugowitsch.
# license Modified BSD, see LICENSE.txt for details.
# ...
name: CI Tests and Docs
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test:
name: Run Pytest Suite
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install package and test dependencies
run: |
python -m pip install --upgrade pip
pip install .[test]
- name: Run tests
run: |
pytest test/
docs:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install docs dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs]
- name: Build Sphinx documentation
run: |
sphinx-build -b html docs docs/_build