docs: convert reStructuredText sources to MyST markdown#1579
Merged
Conversation
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.
Which issue does this PR close?
There is no open issue but this continues the work done in #1578.
Rationale for this change
Phase 2 of the documentation-site refresh started in #1578. With the modern pydata-sphinx-theme + navigation in place, this PR moves the content format off
.rstand onto MyST.md. The motivation:datafusion-cometsibling project completed the same migration recently and reported smoother contributor onboarding.What changes are included in this PR?
rst-to-myst).AGENTS.mdis updated so the two.rstpaths called out under "Aggregate and Window Function Documentation" point at the new.mdequivalents.myst-parsertomyst-nbso that we can do markdown parsing PLUS code execution to render our examples.Are there any user-facing changes?
No behavioral change to the
datafusionpackage — only the source format of the published documentation. Readers of the rendered site will not notice the migration; the HTML output is slightly updated but still shows all of the relevant content including running code.Follow-ups (out of scope for this PR)
asf-sitepublishing workflow.