Skip to content

Switch README from RST to Markdown#126

Merged
ad-m merged 1 commit intomasterfrom
readme-rst-to-md
Mar 7, 2026
Merged

Switch README from RST to Markdown#126
ad-m merged 1 commit intomasterfrom
readme-rst-to-md

Conversation

@ad-m
Copy link
Owner

@ad-m ad-m commented Mar 7, 2026

Summary

  • Convert README.rst to README.md with equivalent Markdown constructs (badges, code blocks, links, admonition)
  • Update pyproject.toml to reference README.md
  • Inline previously-included README content into docs/index.rst and docs/usage.rst since Sphinx docs remain RST-based

Test plan

  • Verify README.md renders correctly on GitHub
  • Verify pip install -e . still picks up the readme
  • Verify Sphinx docs build without errors (cd docs && make html)

🤖 Generated with Claude Code

Markdown is the dominant format on GitHub, renders natively, and is
easier for contributors to edit. Inline the previously-included
content into the Sphinx docs since they remain RST-based.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ad-m ad-m merged commit 36fbb40 into master Mar 7, 2026
6 of 7 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.

1 participant