Skip to content

Add ReadTheDocs documentation page#19

Merged
hechth merged 3 commits into
mainfrom
copilot/add-readthedocs-page
Mar 25, 2026
Merged

Add ReadTheDocs documentation page#19
hechth merged 3 commits into
mainfrom
copilot/add-readthedocs-page

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 25, 2026

Sets up Sphinx-based documentation hosted on ReadTheDocs, with the landing page sourcing content directly from the existing README.md to avoid duplication.

Changes

  • .readthedocs.yaml — RTD v2 config; Ubuntu 22.04, Python 3.11, points to docs/conf.py
  • docs/conf.py — Sphinx config using sphinx-rtd-theme and myst-parser
  • docs/index.md — Landing page that pulls README content via MyST {include}:
    ```{include} ../README.md
  • requirements/docs.txt — Pinned deps: sphinx==8.1.3, sphinx-rtd-theme==3.0.2, myst-parser==4.0.0
  • docs/_static/.gitkeep — Keeps the static assets directory tracked by Git
Original prompt

This section details on the original issue you should resolve

<issue_title>Add a readthedocs page</issue_title>
<issue_description>Add the skeleton and config required to host a documentation page using readthedocs. Also, include the information from the readme in the landing page of the readthedocs.</issue_description>

Comments on the Issue (you are @copilot in this section)


⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.

Copilot AI changed the title [WIP] Add skeleton and config for ReadTheDocs page Add ReadTheDocs documentation page Mar 25, 2026
Copilot AI requested a review from hechth March 25, 2026 17:34
@hechth hechth marked this pull request as ready for review March 25, 2026 19:32
@hechth hechth merged commit e67b15e into main Mar 25, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a readthedocs page

2 participants