Docs

[hotung1027]

This pull request introduces a new Read the Docs configuration file to the project. The configuration sets up the environment for building documentation with Sphinx, specifying the operating system, Python version, and necessary pre-installation steps.

Documentation build setup:

• Added a .readthedocs.yaml file to configure documentation builds using Sphinx, specifying Ubuntu 24.04, Python 3.13, and custom pre-install steps with uv for environment and dependency management.

[hotung1027]

lgtm

[Copilot]

Pull request overview

Adds a Read the Docs configuration to enable building this project’s Sphinx documentation on RTD, complementing the existing docs build setup in GitHub Actions.

Changes:

• Introduced .readthedocs.yaml with RTD v2 config (Ubuntu 24.04, Python 3.13).
• Added uv-based pre-install steps intended to create/use a venv and install docs extras.
• Configured RTD to build docs via docs/conf.py.

Comments suppressed due to low confidence (2)

.readthedocs.yaml:22

• YAML indentation is inconsistent under sphinx: (3 spaces before configuration). This is easy to misread and can cause subtle YAML issues; align it to the same 2-space indentation used elsewhere in the file.

sphinx:
   configuration: docs/conf.py

.readthedocs.yaml:29

• There’s trailing whitespace/blank padding at the end of the file. Please remove it to avoid unnecessary diff churn and potential whitespace-lint failures.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The source .../activate step likely won’t affect the following uv sync line if Read the Docs runs each pre_install command in a separate shell/process, causing dependencies to be installed outside the intended virtualenv. Consider combining activation + sync into a single command, or invoke uv in a way that explicitly targets $READTHEDOCS_VIRTUALENV_PATH without relying on source.

Suggested change

	- uv venv $READTHEDOCS_VIRTUALENV_PATH
	- source $READTHEDOCS_VIRTUALENV_PATH/bin/activate
	- uv sync --extra docs
	- uv venv $READTHEDOCS_VIRTUALENV_PATH && source $READTHEDOCS_VIRTUALENV_PATH/bin/activate && uv sync --extra docs