57 add documentation #63

	name: sonarcloud

	on:
	push:
	branches:
	- main
	pull_request:
	branches:
	- main

	jobs:

	sonarcloud:
	name: SonarCloud
	runs-on: ubuntu-latest
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.10", "3.11"]
	steps:
	- uses: actions/checkout@v3
	with:
	fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
	- 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 .[dev]
	- name: Run unit tests with coverage
	run: pytest --cov --cov-report term --cov-report xml
	- name: Correct coverage paths
	run: sed -i "s+$PWD/++g" coverage.xml
	- name: SonarCloud Scan
	uses: SonarSource/sonarcloud-github-action@master
	env:
	GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN }}
	SONAR_TOKEN: ${{secrets.SONAR_TOKEN }}

Provide feedback