[GitHub] [kyuubi] pan3793 commented on a diff in pull request #4649: [DOCS] Improve Markdown docs and fix unlink pages

["pan3793 (via GitHub)" <gi...@apache.org>]

pan3793 commented on code in PR #4649:
URL: https://github.com/apache/kyuubi/pull/4649#discussion_r1155290516


##########
docs/conf.py:
##########
@@ -76,13 +67,42 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
-    'recommonmark',
-    'sphinx_markdown_tables',
     'sphinx_togglebutton',
+    'myst_parser',
     'notfound.extension',
 ]
 
-master_doc = 'index'
+myst_enable_extensions = [
+    "amsmath",
+    "attrs_inline",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
+    "replacements",
+    "smartquotes",
+    "strikethrough",
+    "substitution",
+    "tasklist",
+]
+
+myst_substitutions = {
+  "release": release,
+  "kyuubi_hive_jdbc_shaded_maven_ref":
+"""
+```xml
+<dependency>
+    <groupId>org.apache.kyuubi</groupId>
+    <artifactId>kyuubi-hive-jdbc-shaded</artifactId>
+    <version>%s</version>

Review Comment:
   substitution does not support code block, so we need to define to whole block instead



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org