Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show not-yet-released change notes in Sphinx docs #2650

Merged
merged 4 commits into from May 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions 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`
5 changes: 5 additions & 0 deletions docs/conf.py
Expand Up @@ -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 = '..'
2 changes: 2 additions & 0 deletions docs/history.rst
Expand Up @@ -5,6 +5,8 @@
History
*******

.. towncrier-draft-entries:: DRAFT, unreleased as on |today|

.. include:: ../CHANGES (links).rst

Credits
Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Expand Up @@ -75,6 +75,7 @@ docs =
# local
pygments-github-lexers==0.0.5
sphinx-inline-tabs
sphinxcontrib-towncrier

ssl =
wincertstore==0.2; sys_platform=='win32'
Expand Down