docs: convert prose .rst files to MyST .md#383
Merged
Conversation
Keeps docs/api/*.rst and docs/_templates/*.rst as RST — autosummary-driven pages don't gain readability from a MyST conversion. Adds `substitution` to myst_enable_extensions for existing substitution blocks. Part of PyAutoLabs/PyAutoFit#1245. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Catches the branch up to main. The 2026.5.1.1 and 2026.5.1.4 release commits bumped the Colab URL tag in several .rst files on main; those files were deleted in the conversion, so the modify/delete conflicts are resolved by keeping the deletion and porting the bump (2026.4.13.6 → 2026.5.1.4) to the MyST .md siblings: - docs/index.md - docs/howtogalaxy/chapter_1_introduction.md - docs/howtogalaxy/chapter_2_modeling.md - docs/howtogalaxy/chapter_3_search_chaining.md - docs/howtogalaxy/chapter_4_pixelizations.md - docs/howtogalaxy/chapter_optional.md - docs/overview/overview_2_new_user_guide.md Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Branch caught up to
See merge commit 8e577a8. No structural changes — URL-tag substitution only. |
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
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
Converts 23 prose documentation pages from reStructuredText to MyST Markdown so they're easier for contributors and AI tools to read and edit. The autosummary-driven
docs/api/anddocs/_templates/files are intentionally left as.rst— their dense directive blocks gain nothing from a MyST colon-fence rewrite, and the autogenerated_autosummary/stubs are.rstregardless.Adds
substitutiontomyst_enable_extensionsindocs/conf.pyfor substitution blocks present in the converted prose.myst-parserwas already configured. Sphinx accepts mixed.rst/.mdsource trees, and toctree entries reference file stems, so no toctree edits were needed.Part of PyAutoLabs/PyAutoFit#1245.
API Changes
None — internal docs only.
Test Plan
sphinx-build -b html docs docs/_build/htmlruns cleanly with zero new warnings on converted.mdfilesFull API Changes (for automation & release notes)
None — this PR only changes documentation source files.
🤖 Generated with Claude Code