57 add documentation #50

	# This workflow will install Python dependencies with a variety of Python versions
	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

	name: Build

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

	jobs:
	build:

	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
	python-version: ["3.10", "3.11", "3.12"]

	steps:
	- uses: actions/checkout@v3
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v3
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	python -m pip install build
	python -m pip install .[dev]
	- name: Build the package
	run: python -m build
	- name: Test with pytest
	run: python -m pytest

	build_doc:
	runs-on: ubuntu-latest
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.10", "3.11", "3.12"]

	steps:
	- uses: actions/checkout@v3
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v3
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install documentaion dependencies
	run: \|
	python -m pip install --upgrade pip
	python -m pip install mkdocs mkdocs-material mkdocs-jupyter mkdocstrings[python] mkdocs-gen-files
	- name: Build documentaion
	run: mkdocs build

Provide feedback