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

Add a preview for the "next release" change notes #9172

Merged
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/html/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

import glob
import os
import pathlib
import re
import sys

Expand All @@ -36,6 +37,7 @@
'sphinx.ext.intersphinx',
# third-party:
'sphinx_inline_tabs',
'sphinxcontrib.towncrier',
# in-tree:
'docs_feedback_sphinxext',
'pip_sphinxext',
Expand Down Expand Up @@ -316,3 +318,10 @@ def to_document_name(path, base_dir):
'What content was useful?',
'What content was not useful?',
)

# -- Options for towncrier_draft extension -----------------------------------

towncrier_draft_autoversion_mode = 'draft' # or: 'sphinx-release', 'sphinx-version'
towncrier_draft_include_empty = True
towncrier_draft_working_directory = pathlib.Path(docs_dir).parent
# Not yet supported: towncrier_draft_config_path = 'pyproject.toml' # relative to cwd
2 changes: 2 additions & 0 deletions docs/html/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ Changelog
Major and minor releases of pip also include changes listed within
prior beta releases.

.. towncrier-draft-entries:: |release|, unreleased as on

.. include:: ../../NEWS.rst
1 change: 1 addition & 0 deletions news/9172.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Render the unreleased pip version change notes on the news page in docs.
1 change: 1 addition & 0 deletions tools/requirements/docs.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
sphinx == 3.2.1
furo
sphinx-inline-tabs
sphinxcontrib-towncrier

# `docs.pipext` uses pip's internals to generate documentation. So, we install
# the current directory to make it work.
Expand Down