diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-05-19 11:50:34 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-19 11:50:34 -0400 |
| commit | f08262e5af7fa20898e3b0a1d449c9f4fb24aefb (patch) | |
| tree | 78999606378ffbb7e04405fd8339d647dc5fd68c | |
| parent | 317ad2c4c9edf793e65372e80ec2d64f4edf147f (diff) | |
| parent | d3cc031edaa843ad796c5e1e079c1e4b58bcec06 (diff) | |
| download | python-setuptools-git-f08262e5af7fa20898e3b0a1d449c9f4fb24aefb.tar.gz | |
Merge pull request #2677 from pypa/docs/towncrier-draft
Publish draft change notes
| -rw-r--r-- | changelog.d/2650.misc.rst | 3 | ||||
| -rw-r--r-- | docs/conf.py | 7 | ||||
| -rw-r--r-- | docs/history.rst | 2 | ||||
| -rw-r--r-- | setup.cfg | 1 |
4 files changed, 13 insertions, 0 deletions
diff --git a/changelog.d/2650.misc.rst b/changelog.d/2650.misc.rst new file mode 100644 index 00000000..f15ec3d8 --- /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 93b19b57..4548cf27 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -143,3 +143,10 @@ intersphinx_mapping.update( 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 = '..' +# Avoid an empty section for unpublished changes. +towncrier_draft_include_empty = False diff --git a/docs/history.rst b/docs/history.rst index faf7adfe..ce7e77ab 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 @@ -75,6 +75,7 @@ docs = # local pygments-github-lexers==0.0.5 sphinx-inline-tabs + sphinxcontrib-towncrier ssl = wincertstore==0.2; sys_platform=='win32' |