Add sphinx towncrier extension and link changelog

py-mine · Feb 7, 2023 · fac659a · fac659a
1 parent 7f9cebd
commit fac659a
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,6 +10,7 @@
 
 import sys
 from datetime import date
+from pathlib import Path
 
 from packaging.version import parse as parse_version
 
@@ -46,6 +47,8 @@
     "m2r2",
     # Copyable codeblocks
     "sphinx_copybutton",
+    # Towncrier changelog
+    "sphinxcontrib.towncrier.ext",
 ]
 
 autoclass_content = "both"
@@ -104,6 +107,11 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# Towncrier
+towncrier_draft_autoversion_mode = "draft"
+towncrier_draft_include_empty = True
+towncrier_draft_working_directory = Path(__file__).parents[1].resolve()
+
 
 # -- Other options -----------------------------------------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,7 @@ Content
     pages/installation.rst
     examples/index.rst
     pages/faq.rst
+    pages/changelog.rst
     pages/contributing.rst
     pages/code-of-conduct.rst
 

diff --git a/docs/pages/changelog.rst b/docs/pages/changelog.rst
@@ -0,0 +1,9 @@
+Changelog
+=========
+
+.. attention::
+    Major and minor releases also include the changes specified in prior development releases.
+
+.. towncrier-draft-entries:: Unreleased changes
+
+.. mdinclude:: ../../CHANGELOG.md
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -87,6 +87,7 @@ m2r2 = "^0.3.3.post2"
 packaging = "^23.0"
 sphinx-autodoc-typehints = "^1.22"
 sphinx-copybutton = "^0.5.1"
+sphinxcontrib-towncrier = "^0.3.2a0"
 
 [tool.poetry.group.docs-ci]
 optional = true