docs: restructure sphinx documentation

[afuetterer]

This will be a longer PR to fix #443.

I will set it to draft for now.

Waiting for related PRs

• waiting for chore: remove obsolete docs #480 to merged
• waiting for chore: reorder .gitignore #483 to merged
• waiting for ci: rename docs workflow #478 to merged
• waiting for build(deps): add dependency-groups #479 to merged
• test: fix coverage reporting #489

Tasks

• rebase
• add "documentation" to project.urls in pyproject.toml
• remove readme.rst
• include "readme.md" in index.rst
• update docs/source/conf.py
  • add link to github repo (see https://pradyunsg.me/furo/customisation/footer/#configuration)
  • add sphinx-apidoc settings
• add more badges to readme
• fix documentation gha workflow
• add docs build to ci to test if a pr breaks the docs?
• workflow call, call from pr as well
• if pr, do not deploy...
• fix docstrings in python modules
• squash commits
• configure the GitHub actions workflow as the source of your deployment (needs to be done by @chrismattmann in repo settings)

[coveralls]

Coverage is 67.356% — afuetterer:443-docs into chrismattmann:master. No base build found for chrismattmann:master.

[afuetterer]

For these changes to take effect, please configure the GitHub actions workflow as the source of your deployment. Otherwise you will still have only the readme on your page.

See instructions: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow

[chrismattmann]

For these changes to take effect, please configure the GitHub actions workflow as the source of your deployment. Otherwise you will still have only the readme on your page.

See instructions: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow

I will take a look how to do this this week, thanks @afuetterer the pre-req PRs are now merged.