docs: Myst sphinx extension

Change-Id: Id5b8b70fd667318e79e99c1e21d92801aacaa254 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/116424 Reviewed-by: Chad Norvell <[email protected]> Commit-Queue: Anthony DiGirolamo <[email protected]>
google · Oct 31, 2022 · dadc6e1 · dadc6e1
1 parent 865608e
commit dadc6e1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 import sphinx
 
 # The suffix of source filenames.
-source_suffix = ['.rst']
+source_suffix = ['.rst', '.md']
 
 # The master toctree document.  # inclusive-language: ignore
 master_doc = 'index'
@@ -46,6 +46,21 @@
     'sphinxarg.ext',  # Automatic documentation of Python argparse
     'sphinxcontrib.mermaid',
     'sphinx_design',
+    'myst_parser',
+]
+
+myst_enable_extensions = [
+    # "amsmath",
+    "colon_fence",
+    # "deflist",
+    "dollarmath",
+    # "html_admonition",
+    # "html_image",
+    # "linkify",
+    # "replacements",
+    # "smartquotes",
+    # "substitution",
+    # "tasklist",
 ]
 
 _DIAG_HTML_IMAGE_FORMAT = 'SVG'

diff --git a/pw_env_setup/py/pw_env_setup/virtualenv_setup/pigweed_upstream_requirements.txt b/pw_env_setup/py/pw_env_setup/virtualenv_setup/pigweed_upstream_requirements.txt
@@ -16,6 +16,7 @@
 # pigweed.dev Sphinx themes
 furo==2022.6.21
 sphinx-design==0.2.0
+myst-parser==0.18.1
 # Renode requirements
 psutil==5.9.1
 robotframework==5.0.1