Skip to content

Convert docs from reST to MyST#2947

Closed
denuoweb wants to merge 16 commits into
pallets:mainfrom
denuoweb:docs/rst-to-myst
Closed

Convert docs from reST to MyST#2947
denuoweb wants to merge 16 commits into
pallets:mainfrom
denuoweb:docs/rst-to-myst

Conversation

@denuoweb
Copy link
Copy Markdown
Contributor

@denuoweb denuoweb commented May 26, 2025

This PR switches the documentation from reST to MyST.

@denuoweb denuoweb marked this pull request as ready for review May 26, 2025 01:08
@davidism
Copy link
Copy Markdown
Member

Thanks for putting in time to work on this. We need to clean it up so this PR focuses only on the syntax change and nothing else. That will make it easier to review.

  • First two commits need to be combined, git blame is more likely to treat those as renames, or to detect changes across files, if they're in the same commit.
  • Don't change any writing, same reason as above.
  • Don't use autodoc2, I still prefer the results from autodoc.
  • Don't use linkify extension, all links should be using syntax rather than detection.
  • Don't bring in new extensions such as sphinx-design.
  • Bring back the two extensions that were removed.

@denuoweb denuoweb changed the title Convert docs to MyST and switch to autodoc2 Convert docs from reST to MyST May 26, 2025
@denuoweb denuoweb closed this May 26, 2025
@denuoweb denuoweb deleted the docs/rst-to-myst branch May 26, 2025 08:52
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants