docs: add changelog to docs

jolars · Dec 13, 2023 · defdaae · defdaae
1 parent 15c1166
commit defdaae
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1,4 @@
+.. _changelog:
+
+.. include:: ../../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,6 +24,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx_copybutton",
+    "myst_parser",
 ]
 templates_path = ["_templates"]
 exclude_patterns = [

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,3 +13,4 @@
    :caption: Contents:
 
    api
+   changelog
diff --git a/pyproject.toml b/pyproject.toml
@@ -52,7 +52,7 @@ changelog = "https://github.com/jolars/sortedl1/blob/main/CHANGELOG.md"
 tracker = "https://github.com/jolars/sortedl1/issues"
 
 [project.optional-dependencies]
-docs = ["sphinx", "furo", "sphinx-copybutton"]
+docs = ["sphinx", "furo", "sphinx-copybutton", "myst-parser"]
 
 [tool.scikit-build]
 build-dir = "build/{wheel_tag}"