feat: Add support for markdown docs.

This will allow us to write documentation in either markdown or RST and it can cross link and the documenter can use whichever they want. This uses the MyST parser which documents how to write common sphinxs concepts in markdown: https://myst-parser.readthedocs.io/en/latest/index.html
openedx · Jan 23, 2025 · d41f42a · d41f42a
1 parent 25986c2
commit d41f42a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/requirements/base.in b/requirements/base.in
@@ -12,3 +12,4 @@ sphinxcontrib-images
 sphinxcontrib-contentui
 sphinxext-rediraffe
 sphinx-tags
+myst_parser
diff --git a/source/conf.py b/source/conf.py
@@ -47,7 +47,8 @@
     "sphinxcontrib.mermaid",
     "sphinx.ext.intersphinx",
     "sphinxext.rediraffe",
-    "sphinx_tags"
+    "sphinx_tags",
+    "myst_parser",
 ]
 
 # Extension Configuration