Skip to content

Add Read the Docs configuration file#3

Merged
moshez merged 1 commit into
mainfrom
claude/add-rtd-config-nCsj5
May 16, 2026
Merged

Add Read the Docs configuration file#3
moshez merged 1 commit into
mainfrom
claude/add-rtd-config-nCsj5

Conversation

@moshez
Copy link
Copy Markdown
Owner

@moshez moshez commented May 16, 2026

Summary

Add a .readthedocs.yaml configuration file to enable automated documentation builds on Read the Docs.

Changes

  • Added .readthedocs.yaml with Read the Docs v2 configuration
  • Configured build environment to use Ubuntu 24.04 with Python 3.13
  • Set Sphinx configuration path to doc/conf.py
  • Enabled strict mode (fail_on_warning: true) to catch documentation issues
  • Configured pip to install documentation dependencies from requirements-docs.txt and the project itself

Details

This configuration enables Read the Docs to automatically build and host project documentation. The strict warning mode ensures documentation quality by treating warnings as build failures.

https://claude.ai/code/session_0195heKdns3BSzFffi3qxFud

@moshez moshez merged commit 4394a2f into main May 16, 2026
14 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.

2 participants