Build

Docstrings for ShaRP methods #140

	name: Build

	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]

	workflow_dispatch:


	permissions:
	contents: write

	jobs:
	linting:
	name: Linting
	runs-on: ubuntu-latest
	steps:
	- name: Checkout code
	uses: actions/checkout@v2

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: 3.12
	architecture: x64

	- name: Install dependencies
	run: \|
	pip install ".[tests]"

	- name: Run code analysis (black, mypy, flake8, pylint)
	run: \|
	make code-analysis

	build:
	strategy:
	fail-fast: false
	matrix:
	# NOTE: macos-13 is a workaround for an issue with the latest version
	os: [ubuntu-latest, macos-13, windows-latest]
	python: [3.9, "3.10", 3.11, 3.12]
	name: ${{ matrix.os }} Python ${{ matrix.python }}
	runs-on: ${{ matrix.os }}
	steps:
	- uses: actions/checkout@v2

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: ${{ matrix.python }}
	architecture: x64

	- name: Install
	run: \|
	# NOTE: pip, setuptools and wheel should be included with any python
	# installation. It's being installed/upgraded here because the
	# setup-python action is not including setuptools with Python 3.12
	pip install --upgrade pip setuptools wheel
	pip install .[tests,optional,docs]

	- name: Test library
	run: \|
	make test

	- name: Upload coverage to codecov
	uses: codecov/codecov-action@v4
	with:
	files: ./coverage.xml
	fail_ci_if_error: false
	token: ${{ secrets.CODECOV_TOKEN }}
	slug: DataResponsibly/sharp

	- name: Test Docs
	run: \|
	cd doc
	make html

Provide feedback