docs: convert prose .rst to MyST .md (pass 2)#6
Merged
Conversation
Continues the rst→md migration started in PyAutoFit#1245. Converts
all 14 prose .rst files (root README + CITATIONS, config/ READMEs,
notebooks/ and scripts/ chapter READMEs).
- README rewritten using a plain Markdown <img> tag instead of the
MyST-only `{image}` directive so the logo gif renders on GitHub
- CITATIONS leading `(references)=` MyST anchor dropped (was
unreferenced and rendered as literal text outside Sphinx)
- chapter READMEs: rst-to-myst's escaped-dash continuation pattern
rewritten as proper Markdown list items
- prose ref to "each chapter's README.rst" updated to README.md
No pyproject/MANIFEST changes — HowToFit isn't pip-installable.
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Continues the rst→md migration started in PyAutoFit#1245. Converts all 14 prose
.rstfiles (root README + CITATIONS,config/READMEs,notebooks/andscripts/chapter READMEs).<img>tag instead of MyST-only{image}so the logo gif renders on GitHub(references)=MyST anchor dropped (was unreferenced and rendered as literal text outside Sphinx)No pyproject/MANIFEST changes — HowToFit isn't pip-installable.
Test plan
🤖 Generated with Claude Code