From 8f124fcff90eba4256eddaa8d24d8ff989d66273 Mon Sep 17 00:00:00 2001 From: Kiran Gopinathan Date: Fri, 22 May 2026 12:08:41 -0400 Subject: [PATCH] Add z3py guide to Sphinx docs via myst-parser Moved z3py-guide.md into docs/source/ so Sphinx picks it up. Added myst-parser extension for markdown support and wired the guide into the Getting Started toctree. --- docs/source/conf.py | 1 + docs/source/index.rst | 1 + docs/{ => source}/z3py-guide.md | 0 pyproject.toml | 1 + 4 files changed, 3 insertions(+) rename docs/{ => source}/z3py-guide.md (100%) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e04024..254d3bc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,6 +19,7 @@ "sphinx.ext.viewcode", "sphinx.ext.napoleon", "sphinx_autodoc_typehints", + "myst_parser", ] typehints_use_signature = True diff --git a/docs/source/index.rst b/docs/source/index.rst index 5d97960..28031fd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,6 +22,7 @@ Effortless interop between **Lean 4** and **Python**, in both directions. getting_started project_setup + z3py-guide .. toctree:: :maxdepth: 1 diff --git a/docs/z3py-guide.md b/docs/source/z3py-guide.md similarity index 100% rename from docs/z3py-guide.md rename to docs/source/z3py-guide.md diff --git a/pyproject.toml b/pyproject.toml index 30376f7..331e433 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,6 +21,7 @@ docs = [ "sphinx", "sphinx_rtd_theme", "sphinx_autodoc_typehints", + "myst-parser", ] [project.urls]