llvm/llvm-iwg

Switch recommonmark to myst-parser

Open

#30 opened on Apr 21, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees) (14 forks)github user discovery
help wanted

Repository metrics

Stars
 (18 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Locate the Sphinx configuration file (conf.py) in the repository, replace the recommonmark extension with MyST Parser, update any configuration options, and test the documentation build locally.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinxGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75