From d41f42a8dfb7d959ec4e30d4f5b07c6b57947e68 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Wed, 22 Jan 2025 13:54:56 -0500 Subject: [PATCH] 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 --- requirements/base.in | 1 + source/conf.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/requirements/base.in b/requirements/base.in index 93012e4c8..5edced3a9 100644 --- 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 index 1d53051e3..ab62baa23 100644 --- 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