Add Read the docs files. Before they were auto generated

[lvarin]

Summary by Sourcery

Configure Sphinx and Read the Docs to build project documentation from a new documentation directory.

Build:

• Add a Read the Docs configuration file to define the documentation build environment and Python version.

Documentation:

• Add a Sphinx configuration, index file, and documentation requirements to support building project docs on Read the Docs.

[sourcery-ai]

Reviewer's Guide

Adds an explicit Sphinx configuration and Read the Docs config to version control so docs are no longer auto-generated, and scaffolds the documentation index and requirements files.

Flow diagram for ReadTheDocs build process using new config files

flowchart TD
  S[New commit pushed] --> C[.readthedocs.yaml detected by ReadTheDocs]
  C --> B[Create Python 3.11 environment]
  B --> R[Install dependencies from documentation/requirements.txt]
  R --> L[Load Sphinx configuration from documentation/conf.py]
  L --> P[Parse source files including documentation/index.rst]
  P --> G[Generate HTML using sphinx_rtd_theme]
  G --> D[Publish built docs to ReadTheDocs]

Loading

File-Level Changes

Change	Details	Files
Introduce a tracked Sphinx configuration for the TESK documentation site.	Create documentation/conf.py with project metadata (project, author) Enable the myst_parser extension for Markdown support Configure source suffix mapping for .rst and .md files Set master_doc to index and configure HTML theme sphinx_rtd_theme Define templates and static paths for Sphinx build	documentation/conf.py
Add Read the Docs build configuration pointing to the Sphinx config and Python toolchain.	Specify Read the Docs v2 configuration file with Ubuntu 24.04 image and Python 3.11 Configure Sphinx entry point to documentation/conf.py Configure Python install step to use documentation/requirements.txt	.readthedocs.yaml
Add initial documentation scaffolding and requirements file for documentation builds.	Add documentation/requirements.txt placeholder for doc build dependencies (currently mirroring RTD config; verify this is intentional) Create an empty documentation/index.rst as the Sphinx master document	documentation/requirements.txt documentation/index.rst

---

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.

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• documentation/requirements.txt appears to contain a copy of the Read the Docs YAML config rather than Python package requirements; it should instead list the Sphinx extensions/themes used (e.g., myst_parser, sphinx_rtd_theme) in standard pip requirements format.
• documentation/index.rst is currently empty; consider adding at least a minimal toctree or landing content so that Sphinx has a meaningful root document to render.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- documentation/requirements.txt appears to contain a copy of the Read the Docs YAML config rather than Python package requirements; it should instead list the Sphinx extensions/themes used (e.g., myst_parser, sphinx_rtd_theme) in standard pip requirements format.
- documentation/index.rst is currently empty; consider adding at least a minimal toctree or landing content so that Sphinx has a meaningful root document to render.

## Individual Comments

### Comment 1
<location> `documentation/conf.py:21` </location>
<code_context>
+    ".md": "markdown",
+}
+
+master_doc = "index"
+
+# -- HTML output -------------------------------------------------------------
</code_context>

<issue_to_address>
**suggestion:** Consider using `root_doc` instead of `master_doc` for newer Sphinx versions.

To keep this config forward-compatible with newer Sphinx versions, use `root_doc = "index"` (or the appropriate root) instead of `master_doc`.

```suggestion
# Root document (Sphinx 2.0+)
root_doc = "index"

# Backwards compatibility for older Sphinx versions
master_doc = root_doc
```
</issue_to_address>

---

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.}