Skip to content

Read the Docs Deployment Implementation Plan

For agentic workers: REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (- [ ]) syntax for tracking.

Goal: Configure the project for Read the Docs deployment with native uv support.

Architecture: Create .readthedocs.yaml v2 configuration and verify build environment.

Tech Stack: Read the Docs, uv, MkDocs

Task 1: Configuration

Files: - Create: .readthedocs.yaml

  • [ ] Step 1: Create .readthedocs.yaml in the root directory.
version: 2

build:
  os: ubuntu-24.04
  tools:
    python: "3.12"

mkdocs:
  configuration: mkdocs.yml

python:
  install:
    - method: uv
      command: sync
      extra:
        - docs
  • [ ] Step 2: Commit
git add .readthedocs.yaml
git commit -m "docs: add readthedocs configuration"

Task 2: Final Verification

  • [ ] Step 1: Verify local build still works.

Run: make docs-build Expected: site/ folder updated.

  • [ ] Step 2: Push to main
git push origin main