feat: Add readthedocs support

[fsbraun]

Summary by Sourcery

Configure the project to build documentation on ReadTheDocs by restructuring the Sphinx docs directory, updating conf.py to use dynamic metadata, and defining doc dependencies and build settings.

New Features:

• Add ReadTheDocs configuration for automated documentation builds

Enhancements:

• Reorganize Sphinx documentation layout and update Makefile source directory
• Use dynamic version and remove hard-coded titles in Sphinx conf.py

Build:

• Introduce .readthedocs.yaml to define build environment and formats
• Add docs/requirements.txt and align Sphinx dependencies with Poetry

[sourcery-ai]

Reviewer's Guide

This PR adds Read the Docs support by introducing a .readthedocs.yaml configuration, documentation dependencies, restructuring the Sphinx docs layout with dynamic versioning in conf.py, updating the Makefile, and removing obsolete docs files.

Class diagram for updated Sphinx configuration

classDiagram
  class conf_py {
    +author: str
    +release: str
    +html_title: str | None
    # Dynamic versioning via __version__
  }
  class Makefile {
    +SPHINXBUILD: str
    +SOURCEDIR: str (now 'source/')
    +BUILDDIR: str
  }
  Makefile --> conf_py: uses

Loading

File-Level Changes

Change	Details	Files
Introduce Read the Docs build configuration and dependencies	Add .readthedocs.yaml with build, sphinx, format, and python settings Create docs/requirements.txt listing Sphinx and related theme/extensions dependencies	.readthedocs.yaml docs/requirements.txt
Restructure documentation layout and enable dynamic versioning	Move conf.py into docs/source and change release to use version Remove hardcoded html_title and comment out html_short_title Update Makefile SOURCEDIR from '.' to 'source/'	docs/source/conf.py docs/Makefile
Remove outdated documentation files	Delete docs/.gitignore Delete docs/pyproject.toml	docs/.gitignore docs/pyproject.toml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.83%. Comparing base (4b0ea14) to head (53faadc).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #75   +/-   ##
=======================================
  Coverage   90.83%   90.83%           
=======================================
  Files          18       18           
  Lines         851      851           
  Branches       98       98           
=======================================
  Hits          773      773           
  Misses         48       48           
  Partials       30       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}