[PATCH] D142199: [Docs] Replace recommonmark with myst-parser

Luke Lau via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Jan 20 04:12:42 PST 2023


luke created this revision.
luke added reviewers: kuhnel, Shivamgupta1234, mehdi_amini.
Herald added subscribers: kosarev, pmatos, kerbowa, arphaman, jvesely.
Herald added a reviewer: sscalpone.
Herald added projects: Flang, All.
luke requested review of this revision.
Herald added subscribers: llvm-commits, cfe-commits, jdoerfert.
Herald added a reviewer: nicolasvasilache.
Herald added projects: clang, LLVM.

Now that recommonmark is deprecated https://github.com/readthedocs/recommonmark/issues/221,
myst-parser seems to be the generally accepted drop in replacement.
This swaps recommonmark out of the sphinx config and upgrades any
markdown document that needs adjustment due to myst-parser's stricter
parsing.
In particular, these things needed addressed as myst-parser complained
about them:

- Broken references were replaced
- Invalid lexers in code blocks were replaced or removed (It didn't look like they were being syntax highlighted anyway)
- Non-contiguous headers (# -> ###) were made contiguous  (# -> ##)

Closes #55787


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D142199

Files:
  .github/workflows/release-tasks.yml
  clang/docs/conf.py
  flang/docs/ComplexOperations.md
  flang/docs/DiagnosticsReference.md
  flang/docs/FIRArrayOperations.md
  flang/docs/FlangDriver.md
  flang/docs/HighLevelFIR.md
  flang/docs/OptionComparison.md
  flang/docs/ParameterizedDerivedTypes.md
  flang/docs/PullRequestChecklist.md
  flang/docs/conf.py
  flang/docs/index.md
  flang/include/flang/Optimizer/Dialect/FIROps.td
  llvm/docs/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack.md
  llvm/docs/DeveloperPolicy.rst
  llvm/docs/GitRepositoryPolicy.md
  llvm/docs/MarkdownQuickstartTemplate.md
  llvm/docs/PointerAuth.md
  llvm/docs/SpeculativeLoadHardening.md
  llvm/docs/SphinxQuickstartTemplate.rst
  llvm/docs/conf.py
  llvm/utils/release/build-docs.sh

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D142199.490780.patch
Type: text/x-patch
Size: 91846 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20230120/90ebff12/attachment-0001.bin>


More information about the cfe-commits mailing list