Skip to content

Docs: Replace recommonmark with myst-parser - #117

Open
pniedzielski wants to merge 1 commit into
bloomberg:mainfrom
pniedzielski:docs/myst-parser
Open

pniedzielski wants to merge 1 commit into
bloomberg:mainfrom
pniedzielski:docs/myst-parser

Conversation

@pniedzielski

Copy link
Copy Markdown
Contributor

recommonmark has been deprecated and unmaintained since 2021; its authors recommend myst-parser as the replacement. We only use it to render the Markdown pages (BUILD.md and CHANGELOG.md) included in the Sphinx toctree, and neither page uses any recommonmark-specific features, so this is a drop-in swap of the extension. This patch performs that swap. The rendered HTML for both pages is unchanged.

@pniedzielski
pniedzielski requested a review from a team as a code owner October 16, 2026 20:24
@pniedzielski pniedzielski added the skip news No news entry is required label Oct 16, 2026
recommonmark has been deprecated and unmaintained since 2021; its
authors recommend myst-parser as the replacement.  We only use it to
render the Markdown pages (BUILD.md and CHANGELOG.md) included in the
Sphinx toctree, and neither page uses any recommonmark-specific
features, so this is a drop-in swap of the extension.  This patch
performs that swap.  The rendered HTML for both pages is unchanged.

Signed-off-by: Patrick M. Niedzielski <pniedzielski@bloomberg.net>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip news No news entry is required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants