Skip to content

Conversation

@jtdub
Copy link
Contributor

@jtdub jtdub commented Jan 26, 2026

Summary

This PR adds a .readthedocs.yaml configuration file to enable automated documentation builds on Read the Docs platform.

Key Changes

  • Added Read the Docs v2 configuration file with:
    • Ubuntu 22.04 build environment with Python 3.12
    • Poetry dependency management setup
    • MkDocs as the documentation builder
    • Proper installation of project dependencies and dev tools

Implementation Details

  • Configured post-environment creation hook to install Poetry
  • Set up post-install hook to install all dependencies (including dev) via Poetry
  • Specified MkDocs configuration file location (mkdocs.yml)
  • Declared pip-based Python package installation for reproducible builds
  • Follows Read the Docs best practices for reproducible documentation builds

This enables the project's documentation to be automatically built and hosted on Read the Docs whenever changes are pushed to the repository.

- Configure build environment with Ubuntu 22.04 and Python 3.12
- Set up Poetry for dependency management
- Configure MkDocs build with mkdocs.yml
- Enable automatic documentation builds on ReadTheDocs
@jtdub jtdub merged commit 482d1b4 into main Jan 26, 2026
5 checks passed
@jtdub jtdub deleted the claude/add-readthedocs-config-xwGqu branch January 26, 2026 01:09
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.

3 participants