Doc: added changelog

PlotPyStack · Nov 17, 2023 · a5102e9 · a5102e9
1 parent d76ad04
commit a5102e9
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# PlotPy Releases #
+# Changelog #
 
 ## Version 2.0.1 ##
 

diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -0,0 +1,2 @@
+.. include:: ../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/doc/conf.py b/doc/conf.py
@@ -18,6 +18,7 @@
 # -- General configuration ---------------------------------------------------
 extensions = [
     "sphinx.ext.autodoc",
+    "myst_parser",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",

diff --git a/doc/index.rst b/doc/index.rst
@@ -50,5 +50,6 @@ Table of contents
    intro/index
    features/index
    dev/index
+   changelog
 
 * :ref:`genindex`
diff --git a/doc/requirements.rst b/doc/requirements.rst
@@ -72,6 +72,9 @@ Optional modules for building the documentation:
     * - sphinx
       - 
       - Python documentation generator
+    * - myst_parser
+      - 
+      - An extended [CommonMark](https://spec.commonmark.org/) compliant parser,
     * - sphinx-copybutton
       - 
       - Add a copy button to each of your code cells.

diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,7 @@ dev = ["black", "isort", "pylint", "Coverage", "Cython"]
 doc = [
     "PyQt5",
     "sphinx",
+    "myst_parser",
     "sphinx-copybutton",
     "sphinx_qt_documentation",
     "python-docs-theme",

diff --git a/requirements.txt b/requirements.txt
@@ -15,5 +15,6 @@ pytest-qt
 pytest-xvfb
 python-docs-theme
 sphinx
+myst_parser
 sphinx-copybutton
 sphinx_qt_documentation