diff options
author | cor3ntin <corentinjabot@gmail.com> | 2023-09-25 14:02:39 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-25 14:02:39 +0200 |
commit | b7ff03206d668cd5a620a9d4e1b22ea112ed56e3 (patch) | |
tree | 394898f99ec56cd1caf1eaad5caf54eee4567388 /llvm/docs/conf.py | |
parent | 92a394e4219cee347f187ad798258c5177612f27 (diff) | |
download | llvm-b7ff03206d668cd5a620a9d4e1b22ea112ed56e3.zip llvm-b7ff03206d668cd5a620a9d4e1b22ea112ed56e3.tar.gz llvm-b7ff03206d668cd5a620a9d4e1b22ea112ed56e3.tar.bz2 |
[Documentation] Replace recommonmark by myst-parser (#65664)
Recommonmark has been deprecated, then archived last year. This was
tracked by: https://github.com/llvm/llvm-iwg/issues/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
Diffstat (limited to 'llvm/docs/conf.py')
-rw-r--r-- | llvm/docs/conf.py | 23 |
1 files changed, 3 insertions, 20 deletions
diff --git a/llvm/docs/conf.py b/llvm/docs/conf.py index 206f72285..cf8a759 100644 --- a/llvm/docs/conf.py +++ b/llvm/docs/conf.py @@ -26,31 +26,14 @@ from datetime import date # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ["sphinx.ext.intersphinx", "sphinx.ext.todo"] +extensions = ["myst_parser", "sphinx.ext.intersphinx", "sphinx.ext.todo"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] -# The suffix of source filenames. -source_suffix = { - ".rst": "restructuredtext", -} +source_suffix = [".rst", ".md"] -try: - import recommonmark -except ImportError: - # manpages do not use any .md sources - if not tags.has("builder-man"): - raise -else: - import sphinx - - if sphinx.version_info >= (3, 0): - # This requires 0.5 or later. - extensions.append("recommonmark") - else: - source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - source_suffix[".md"] = "markdown" +import sphinx # The encoding of source files. # source_encoding = 'utf-8-sig' |