Merge pull request #2025 from rzetelskik/remove-sphinx-scylladb-markdown

Remove sphinx-scylladb-markdown dependency from docs
scylladb · Jul 17, 2024 · bb6cd11 · bb6cd11
2 parents 2edb39b + ce5d6a0
commit bb6cd11
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 87 deletions.
diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -15,7 +15,7 @@ sphinx-autobuild = "2021.3.14"
 Sphinx = "7.2.6"
 sphinx-multiversion-scylla = "~0.3.1"
 redirects_cli ="~0.1.3"
-sphinx-scylladb-markdown = "~0.1.3"
+myst-parser = ">=2.0.0"
 sphinx-design = "^0.5.0"
 
 [build-system]

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -16,8 +16,8 @@
     'sphinx_scylladb_theme',
     'sphinx_multiversion',
     "sphinx_sitemap",
-    "sphinx_scylladb_markdown",
-    "sphinx_design"
+    "sphinx_design",
+    "myst_parser",
 ]
 
 # The suffix(es) of source filenames.
@@ -48,6 +48,11 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# -- Options for myst parser
+
+myst_enable_extensions = ["colon_fence"]
+myst_heading_anchors = 6
+
 # -- Options for not found extension
 
 # Template used to render the 404.html generated by this extension.
@@ -61,10 +66,6 @@
 # Read a YAML dictionary of redirections and generate an HTML file for each
 redirects_file = "./redirections.yaml"
 
-# -- Options for markdown extension
-scylladb_markdown_enable = True
-scylladb_markdown_recommonmark_versions = ['v1.9', 'v1.10']
-
 # -- Options for multiversion extension
 # Whitelist pattern for tags (set to None to ignore all tags)
 TAGS = []