docs: enable a few additional features for the generated Markdown documentation - #1282
Open
jenstroeger wants to merge 1 commit into
Open
docs: enable a few additional features for the generated Markdown documentation#1282jenstroeger wants to merge 1 commit into
jenstroeger wants to merge 1 commit into
Conversation
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
1 participant
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.
It’s been a while since we revisited the Markdown documentation that Sphinx generates. This PR enables a couple of features that the extension now provides.
Interestingly, there is also MyST which allows for extensive Markdown support when writing documentation, instead of using ReStructuredText. And Sphinx Extensions is an interesting and opinionated list of useful extension – both perhaps worth linking to in our docs?