Skip to content

docs: convert index.rst to MyST .md#294

Merged
Jammy2211 merged 2 commits intomainfrom
feature/rst-to-myst-md
May 4, 2026
Merged

docs: convert index.rst to MyST .md#294
Jammy2211 merged 2 commits intomainfrom
feature/rst-to-myst-md

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

Converts the single prose page (docs/index.rst, a thin wrapper around the project README) to MyST Markdown for consistency with the conversion across the other PyAuto libraries. Adds myst_parser to the Sphinx extensions list — it wasn't previously configured because the docs were RST-only.

Part of PyAutoLabs/PyAutoFit#1245.

API Changes

None — internal docs only.

Test Plan

  • Read the Docs build passes
  • Local sphinx-build -b html docs docs/_build/html runs cleanly
Full API Changes (for automation & release notes)

None — this PR only changes documentation source files.

🤖 Generated with Claude Code

Converts docs/index.rst to docs/index.md and adds `myst_parser` to
the Sphinx extensions list (the docs were RST-only previously).
The single index page is a thin wrapper around the README.

Part of PyAutoLabs/PyAutoFit#1245.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Apr 30, 2026
@Jammy2211
Copy link
Copy Markdown
Collaborator Author

Branch caught up to main.

main advanced 12 commits since the conversion (numpy-2.x __array__ fix, sparse-CPU OOB fix, interferometer pixelization plot fix, jax cleanup, etc.). None of those commits touched the only converted file (docs/index.md), so the merge was clean — no conflicts. See merge commit 9100e0b.

@Jammy2211 Jammy2211 merged commit ff21eb6 into main May 4, 2026
4 checks passed
@Jammy2211 Jammy2211 deleted the feature/rst-to-myst-md branch May 4, 2026 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant