Enable commonmark-ish docs via myst-parser plugin#2856
Merged
Conversation
This updates the doc build to allow pages to be written in markdown using myst-parser, a markdown flavor that extends commonmark with the ability to reference sphinx roles and directives.
JordonPhillips
added
the
no-changelog-needed
yasmewad
approved these changes
Nov 19, 2025
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
2 participants
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.
This adds the myst-parser plugin plugin to the sphinx docs configuration. myst is a markdown flavor that extends commonmark with the ability to call sphinx directives and roles, like so:
Smithy's own doc traits are in commonmark format so I think it makes sense to add this here. I've not attempted to re-write any existing docs as I think that would be a waste of time. With the plugin installed, both rst and markdown are supported simultaneously, differentiated based on the file extension.
I also ran the black formatter on
conf.pyas part of this.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.