fixed myst_parser

philzook58 · May 29, 2024 · f404345 · f404345
1 parent 0d10af4
commit f404345
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# knuckledragger
+# Introduction
 
 Knuckledragger is an attempt at creating a down to earth, highly automated interactive proof assistant in python. It is not attempting to be the most interesting, expressive, or flexible logic in the world. The goal is to support applications like software verification, calculus, equational reasoning, and numerical bounds.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -52,6 +52,11 @@
     ".rst": "restructuredtext",
     ".md": "markdown",
 }
+
+# Optionally, ensure that MyST is the default parser for Markdown files
+source_parsers = {
+    ".md": "myst_parser",
+}
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -2,6 +2,7 @@ Welcome to knuckledragger's documentation!
 ==========================================
 
 .. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 .. toctree::
    :maxdepth: 2