diff --git a/changelog.d/2650.misc.rst b/changelog.d/2650.misc.rst new file mode 100644 index 00000000000..f15ec3d8f2b --- /dev/null +++ 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 index 93b19b57ab9..fc040cf3105 100644 --- 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 index faf7adfe2c2..ce7e77ab408 100644 --- 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 index e8ff6a68c16..2ecba4b3f18 100644 --- 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'