Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch recommonmark to myst-parser #30

Open
ChristianKuehnel opened this issue Apr 21, 2021 · 1 comment
Open

Switch recommonmark to myst-parser #30

ChristianKuehnel opened this issue Apr 21, 2021 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@ChristianKuehnel
Copy link
Collaborator

ChristianKuehnel commented Apr 21, 2021

Just saw on Discourse that the Markdown addon "recommonmark" for Sphinx will be deprecated. This is used in generating our llvm.org website.
https://llvm.discourse.group/t/switch-recommonmark-to-myst-parser/3259

The recommended alternative is MyST-Parser. So I guess it would make sense for LLVM to also switch at some point in time...

Do we consider this in scope for our working group?

I suppose this would mean changing the Sphinx config in the repo and upgrading all machines building the documentation.

@ChristianKuehnel ChristianKuehnel added the help wanted Extra attention is needed label Apr 21, 2021
cor3ntin added a commit to cor3ntin/llvm-project that referenced this issue Sep 7, 2023
This is a bit rough, but i did that while trying to
figure out if there would be a good way to do
pre commit checks on RsT files.

Recommonmark has been deprecated, then archived last year.
This was tracked by: llvm/llvm-iwg#30

https://github.com/readthedocs/recommonmark

Before merging that we would have to update the bots,
which I'm not in a good position to do, so feel free to take over!
cor3ntin added a commit to cor3ntin/llvm-project that referenced this issue Sep 14, 2023
This is a bit rough, but i did that while trying to
figure out if there would be a good way to do
pre commit checks on RsT files.

Recommonmark has been deprecated, then archived last year.
This was tracked by: llvm/llvm-iwg#30

https://github.com/readthedocs/recommonmark

Before merging that we would have to update the bots,
which I'm not in a good position to do, so feel free to take over!
cor3ntin added a commit to llvm/llvm-project that referenced this issue Sep 25, 2023
Recommonmark has been deprecated, then archived last year. This was
tracked by: llvm/llvm-iwg#30

See https://github.com/readthedocs/recommonmark

This patch migrates all our doc to use myst

Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612
searlmc1 pushed a commit to ROCm/llvm-project that referenced this issue Nov 19, 2023
  [Documentation] Replace recommonmark by myst-parser (llvm#65664)

  Recommonmark has been deprecated, then archived last year. This was
  tracked by: llvm/llvm-iwg#30

  See https://github.com/readthedocs/recommonmark

  This patch migrates all our doc to use myst

  Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612

Change-Id: Id3803e8bb22d3e0fdc7c22bca0aef879edff6b2a
@polyzen
Copy link

polyzen commented Mar 24, 2024

Implemented in llvm/llvm-project@b7ff032

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants