python · hauntsaninja · Sep 15, 2024 · Sep 5, 2024 · Sep 5, 2024 · Sep 5, 2024
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
@@ -1,2 +1,3 @@
 sphinx>=5.1.0
 furo>=2022.3.4
+myst-parser>=4.0.0
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1,3 @@
+<!-- This file includes mypy/CHANGELOG.md into mypy documentation -->
+```{include} ../../CHANGELOG.md
+```
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -35,7 +35,10 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.intersphinx", "docs.source.html_builder"]
+extensions = ["sphinx.ext.intersphinx", "docs.source.html_builder", "myst_parser"]
+
+# To prevent myst-parser from warning header level increases
+suppress_warnings = ["myst.header"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -103,6 +103,7 @@ Contents
    error_code_list2
    additional_features
    faq
+   changelog
 
 .. toctree::
    :hidden: