Merge pull request #35 from samsrabin/use-myst

Use MyST markdown parser

Author: samsrabin

conf.py

@@ -39,7 +39,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.githubpages',
-    'sphinx_mdinclude',
+    'myst_parser',
     ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -93,6 +93,15 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# Do not render straight quotes as smart quotes.
+smartquotes = False
+
+# -- Options for MyST Markdown --------------------------------------------
+
+myst_enable_extensions = [
+    "dollarmath",
+]
+
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

doc_builder/build_commands.py

@@ -7,7 +7,7 @@
 import shutil
 from doc_builder import sys_utils  # pylint: disable=import-error
 
-DEFAULT_IMAGE = "ghcr.io/escomp/ctsm/ctsm-docs:v1.0.1"
+DEFAULT_IMAGE = "ghcr.io/escomp/ctsm/ctsm-docs:v2.0.1"
 
 # The path in the container's filesystem where doc-builder's parent repo checkout is mounted
 _CONTAINER_HOME = "/home/user/mounted_home"

test/test_unit_get_build_command.py

@@ -7,7 +7,12 @@
 from unittest.mock import patch
 
 # pylint: disable=import-error
-from doc_builder.build_commands import get_build_command, get_mount_arg, get_container_cli_tool
+from doc_builder.build_commands import (
+    get_build_command,
+    get_mount_arg,
+    get_container_cli_tool,
+    DEFAULT_IMAGE,
+)
 
 # Allow names that pylint doesn't like, because otherwise I find it hard
 # to make readable unit test names
@@ -136,7 +141,7 @@ def test_container(self, mock_get_toplevel_of_doc_builder_parent):
             "--rm",
             "-e",
             "current_version=None",
-            "ghcr.io/escomp/ctsm/ctsm-docs:v1.0.1",
+            DEFAULT_IMAGE,
             "make",
             f"SPHINXOPTS=-W --keep-going -c '{os.path.dirname(conf_py_path)}'",
             "BUILDDIR=/home/user/mounted_home/foorepos/foodocs/versions/main",
@@ -176,7 +181,7 @@ def test_container_relpath(self, mock_get_toplevel_of_doc_builder_parent):
             "--rm",
             "-e",
             "current_version=None",
-            "ghcr.io/escomp/ctsm/ctsm-docs:v1.0.1",
+            DEFAULT_IMAGE,
             "make",
             "SPHINXOPTS=-W --keep-going",
             "BUILDDIR=/home/user/mounted_home/foorepos/foodocs/versions/main",
@@ -216,7 +221,7 @@ def test_container_no_clitool_given(self, mock_get_toplevel_of_doc_builder_paren
             "--rm",
             "-e",
             "current_version=None",
-            "ghcr.io/escomp/ctsm/ctsm-docs:v1.0.1",
+            DEFAULT_IMAGE,
             "make",
             f"SPHINXOPTS=-W --keep-going -c '{os.path.dirname(conf_py_path)}'",
             "BUILDDIR=/home/user/mounted_home/foorepos/foodocs/versions/main",