Merge pull request #2650 from webknjaz/docs/towncrier-upgrade

Show not-yet-released change notes in Sphinx docs
pypa · May 9, 2021 · 99cabc2 · 99cabc2
2 parents 317ad2c + fef727f
commit 99cabc2
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/changelog.d/2650.misc.rst b/changelog.d/2650.misc.rst
@@ -0,0 +1,3 @@
+Updated the docs build tooling to support the latest version of
+Towncrier and show the previews of not-yet-released setuptools versions
+in the changelog -- :user:`webknjaz`
diff --git a/docs/conf.py b/docs/conf.py
@@ -143,3 +143,8 @@
     python=('https://docs.python.org/3', None),
     python2=('https://docs.python.org/2', None),
 )
+
+# Add support for the unreleased "next-version" change notes
+extensions += ['sphinxcontrib.towncrier']
+# Extension needs a path from here to the towncrier config.
+towncrier_draft_working_directory = '..'
diff --git a/docs/history.rst b/docs/history.rst
@@ -5,6 +5,8 @@
 History
 *******
 
+.. towncrier-draft-entries:: DRAFT, unreleased as on |today|
+
 .. include:: ../CHANGES (links).rst
 
 Credits

diff --git a/setup.cfg b/setup.cfg
@@ -75,6 +75,7 @@ docs =
 	# local
 	pygments-github-lexers==0.0.5
 	sphinx-inline-tabs
+	sphinxcontrib-towncrier
 
 ssl =
 	wincertstore==0.2; sys_platform=='win32'