docs: Render the readme in Sphinx (#829)

nbQA-dev · Jul 30, 2023 · 685504e · 685504e
1 parent 8dd4933
commit 685504e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git 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
@@ -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
@@ -1,3 +1,5 @@
+# Overview
+
 ```{include} ../README.md
 
 ```