docs: convert remaining prose .rst to MyST .md (pass 2)#386
Merged
Conversation
Continues the rst→md migration started in PyAutoFit#1245. Converts:
- README.rst (rewritten as plain CommonMark with inline badge links so
it renders correctly on GitHub and PyPI as well as inside Sphinx)
- CITATIONS.rst
- 9× autogalaxy/config/.../README.rst (config and prior subdirs)
Plus infra:
- pyproject.toml: readme content-type → text/markdown
- MANIFEST.in: include README.md / CITATIONS.md
- docs/conf.py: drop the now-stale README.rst / CITATIONS.rst entries
from exclude_patterns
The workspace prose references in docs/general/{configs,workspace}.md
intentionally still say "README.rst" — they point at the
autogalaxy_workspace README which is not being converted in this pass.
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:
README.rst(rewritten to plain CommonMark with inline badge links so it renders on GitHub and PyPI)CITATIONS.rstautogalaxy/config/.../README.rst(config and prior subdirs)Plus infra:
pyproject.toml:readmecontent-type →text/markdownMANIFEST.in: shipsREADME.mdandCITATIONS.mddocs/conf.py: drops the now-staleREADME.rst/CITATIONS.rstentries fromexclude_patternsThe workspace prose references in
docs/general/{configs,workspace}.mdintentionally still say "README.rst" — they point at theautogalaxy_workspaceREADME which is not being converted in this pass.Test plan
text/markdown🤖 Generated with Claude Code