Improve docstrings #103

	# From https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml
	# with minor adaptations

	name: Deploy docs

	# build the documentation whenever there are new commits on main
	on:
	push:
	# branches:
	# - main
	# Alternative: only build for tags.
	# tags:
	# - '*'

	# security: restrict permissions for CI jobs.
	permissions:
	contents: read

	jobs:
	# Build the documentation and upload the static HTML files as an artifact.
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions/setup-python@v4
	with:
	python-version: '3.10'

	- run: pip install -e .[build]
	- run: >
	pdoc
	-o docs-generated
	-t docs/templates
	--docformat=numpy
	--math
	pipt
	popt
	misc
	ensemble
	simulator
	input_output
	docs/dev_guide.py

	- uses: actions/upload-pages-artifact@v1
	with:
	path: docs-generated/

	# Deploy the artifact to GitHub pages.
	# This is a separate job so that only actions/deploy-pages has the necessary permissions.
	deploy:
	needs: build
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v1

Provide feedback