From 67caa89745088e5c0acd083aecd439e5fb550aee Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Wed, 21 Apr 2021 19:00:56 +0200 Subject: [PATCH 1/3] Add a change note for PR #2650 --- changelog.d/2650.misc.rst | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 changelog.d/2650.misc.rst diff --git a/changelog.d/2650.misc.rst b/changelog.d/2650.misc.rst new file mode 100644 index 0000000000..f15ec3d8f2 --- /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` From 5bb42992e2f5cd0d6510056da3576821fc823d2b Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Wed, 21 Apr 2021 18:29:59 +0200 Subject: [PATCH 2/3] Display changelog for unreleased version in docs --- docs/conf.py | 16 ++++++++++++++++ docs/history.rst | 2 ++ setup.cfg | 1 + 3 files changed, 19 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 93b19b57ab..8f3301b123 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,3 +1,6 @@ +from pathlib import Path + + extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" @@ -143,3 +146,16 @@ 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'] + + +# -- Options for towncrier_draft extension -------------------------------------------- + +PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve() + +towncrier_draft_autoversion_mode = "draft" # or: 'sphinx-release', 'sphinx-version' +towncrier_draft_include_empty = True +towncrier_draft_working_directory = PROJECT_ROOT_DIR +# Not yet supported: towncrier_draft_config_path = 'pyproject.toml' # relative to cwd diff --git a/docs/history.rst b/docs/history.rst index faf7adfe2c..ce7e77ab40 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 b4d67bfac1..ab927a31fd 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' From fef727ff3ee6e99e31df74de76f997a8ffa59d5c Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 9 May 2021 12:49:42 -0400 Subject: [PATCH 3/3] Remove seemingly unneeded settings. --- docs/conf.py | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8f3301b123..fc040cf310 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,3 @@ -from pathlib import Path - - extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" @@ -149,13 +146,5 @@ # Add support for the unreleased "next-version" change notes extensions += ['sphinxcontrib.towncrier'] - - -# -- Options for towncrier_draft extension -------------------------------------------- - -PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve() - -towncrier_draft_autoversion_mode = "draft" # or: 'sphinx-release', 'sphinx-version' -towncrier_draft_include_empty = True -towncrier_draft_working_directory = PROJECT_ROOT_DIR -# Not yet supported: towncrier_draft_config_path = 'pyproject.toml' # relative to cwd +# Extension needs a path from here to the towncrier config. +towncrier_draft_working_directory = '..'