This is an automated email from the ASF dual-hosted git repository.
dnskr pushed a commit to branch branch-1.10
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/branch-1.10 by this push:
new 4e9e949fde [KYUUBI #7237] Replace recommonmark with myst
4e9e949fde is described below
commit 4e9e949fde4ec1e659a44ae97eb974088e76af8e
Author: dnskr <[email protected]>
AuthorDate: Fri Nov 7 23:38:53 2025 +0100
[KYUUBI #7237] Replace recommonmark with myst
### Why are the changes needed?
The PR replaces deprecated
[recommonmark](https://github.com/readthedocs/recommonmark) (last release on
December 17, 2020) with recommended
[MyST](https://github.com/executablebooks/MyST-Parser) to generate
documentation from markdown. Sphinx documentation also assumes that MyST is
used.
### How was this patch tested?
Build the docs with the following command, and verify that the pages
generated from the markdown files look the same:
```shell
make html
```
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #7237 from dnskr/replace-recommonmark-with-myst.
Closes #7237
dd2641069 [dnskr] Replace recommonmark with myst
Authored-by: dnskr <[email protected]>
Signed-off-by: dnskr <[email protected]>
(cherry picked from commit bebe10adf369a61b17f1f530126f8808062d2f7e)
Signed-off-by: dnskr <[email protected]>
---
docs/conf.py | 17 +----------------
docs/requirements.txt | 2 +-
2 files changed, 2 insertions(+), 17 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index 9205851497..1a70826d97 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -38,9 +38,6 @@ import datetime
sys.path.insert(0, os.path.abspath('.'))
import sphinx_markdown_tables
-import recommonmark
-from recommonmark.transform import AutoStructify
-from recommonmark.parser import CommonMarkParser
source_suffix = {
'.rst': 'restructuredtext',
@@ -48,10 +45,6 @@ source_suffix = {
'.md': 'markdown',
}
-source_parsers = {
- '.md': CommonMarkParser,
-}
-
# -- Project information -----------------------------------------------------
project = 'Kyuubi'
@@ -76,7 +69,7 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.mathjax',
- 'recommonmark',
+ 'myst_parser',
'sphinx_copybutton',
'sphinx_markdown_tables',
'sphinx_togglebutton',
@@ -126,13 +119,5 @@ pygments_style = 'sphinx'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_css_files = ["css/custom.css"]
-htmlhelp_basename = 'Recommonmarkdoc'
github_doc_root = 'https://github.com/apache/kyuubi/tree/master/docs/'
-def setup(app):
- app.add_config_value('recommonmark_config', {
- 'url_resolver': lambda url: github_doc_root + url,
- 'auto_toc_tree_section': 'Contents',
- 'enable_eval_rst': True,
- }, True)
- app.add_transform(AutoStructify)
diff --git a/docs/requirements.txt b/docs/requirements.txt
index e818ad5c46..717975bb7d 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -18,7 +18,7 @@
#
markdown==3.7
-recommonmark==0.7.1
+myst-parser==4.0.1
sphinx==8.1.3
sphinx-book-theme==1.1.3
sphinx-markdown-tables==0.0.17
