From 685504e5e52d10b49affa70b2f2c8c50f12a9a7e Mon Sep 17 00:00:00 2001
From: James McKinney <26463+jpmckinney@users.noreply.github.com>
Date: Sun, 30 Jul 2023 11:30:07 -0400
Subject: [PATCH] docs: Render the readme in Sphinx (#829)

---
 README.md      | 2 +-
 docs/conf.py   | 6 +++++-
 docs/readme.md | 2 ++
 3 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9e24d127..adb996a7 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@
 - ✅ preserves "quiet mode" trailing semicolons
 - ✅ lints both code and markdown cells
 
-# Table of contents
+## Table of contents
 
 - [Table of contents](#table-of-contents)
   - [🎉 Installation](#-installation)
diff --git a/docs/conf.py b/docs/conf.py
index ed186667..a47f1379 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,12 +33,16 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
+    "myst_parser",
 ]
 
 add_module_names = False
 autodoc_member_order = "bysource"
 autodoc_typehints = "description"
 
+myst_title_to_header = True
+myst_heading_anchors = 3
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -70,7 +74,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
diff --git a/docs/readme.md b/docs/readme.md
index 691383a4..a31fb637 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -1,3 +1,5 @@
+# Overview
+
 ```{include} ../README.md
 
 ```