Skip to content

add readthedocs #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hotung1027 merged 1 commit into from
Feb 11, 2026
Merged

add readthedocs #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"

Comment on lines +8 to +12

Copilot AI Feb 11, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The RTD build is pinned to Python 3.13, but the repo’s docs workflow sets up Python 3.12. If any dependency/extensions behave differently across versions, this can lead to “works in CI, fails on RTD” drift. Consider aligning RTD’s Python version with CI (or explicitly testing docs builds on 3.13 in CI).

Copilot uses AI. Check for mistakes.
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

Comment on lines +7 to +16

Copilot AI Feb 11, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read the Docs will not install any dependencies with the current config, so the Sphinx build is likely to fail (missing sphinx/extensions and runtime deps like anyio). Add a python: install: section to install the project with the docs extra (or otherwise install the docs requirements) so RTD can build reliably.

Copilot uses AI. Check for mistakes.
# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: pyproject.toml

Comment on lines +21 to +23

Copilot AI Feb 11, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commented example - requirements: pyproject.toml is misleading: RTD’s requirements: expects a requirements file (e.g., requirements.txt), not a pyproject.toml. Either update this comment to show the correct python: install: approach for a pyproject-based project (e.g., pip install with extras) or remove it to avoid future copy/paste issues.

Suggested change
# install:
# - requirements: pyproject.toml
# install:
# - method: pip
# path: .
# extra_requirements:
# - docs

Copilot uses AI. Check for mistakes.