From f404345e4b15699c96963d08df4598e68114b2d7 Mon Sep 17 00:00:00 2001 From: Philip Zucker Date: Wed, 29 May 2024 10:15:38 -0400 Subject: [PATCH] fixed myst_parser --- README.md | 2 +- docs/conf.py | 5 +++++ docs/index.rst | 1 + 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e05e453..869d9d2 100644 --- 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 index 1de3ba0..9d139c1 100644 --- 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 index a1a6192..ff81d9f 100644 --- 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