Skip to content

Add Sphinx documentation site with ReadTheDocs setup#42

Merged
knifecake merged 1 commit intomainfrom
docs/readthedocs-setup
Feb 21, 2026
Merged

Add Sphinx documentation site with ReadTheDocs setup#42
knifecake merged 1 commit intomainfrom
docs/readthedocs-setup

Conversation

@knifecake
Copy link
Owner

@knifecake knifecake commented Feb 21, 2026

Closes #13.

Summary

  • Adds a docs/ directory with Sphinx documentation covering all sections from the issue: installation, getting started, configuration, API reference, design & internals, and alternatives
  • Adds .readthedocs.yaml for ReadTheDocs build configuration (following the django-anchor pattern, using uv 0.10.2)
  • Adds a docs dependency group to pyproject.toml and a make docs target
  • Minor fix to the @recurring docstring RST formatting

Test plan

  • make docs builds cleanly with no warnings
  • Import project on readthedocs.org to verify the live build

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@knifecake knifecake merged commit 75487f2 into main Feb 21, 2026
3 checks passed
@knifecake knifecake deleted the docs/readthedocs-setup branch February 21, 2026 19:20
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.

Publish more structured documentation

1 participant