mirror of https://github.com/pypa/pip
Merge pull request #9172 from webknjaz/docs/unreleased-change-fragments-preview
Add a preview for the "next release" change notes
This commit is contained in:
commit
c383ec3b41
|
@ -11,6 +11,7 @@
|
|||
|
||||
import glob
|
||||
import os
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
|
@ -34,6 +35,7 @@ extensions = [
|
|||
'sphinx.ext.intersphinx',
|
||||
# third-party:
|
||||
'sphinx_inline_tabs',
|
||||
'sphinxcontrib.towncrier',
|
||||
# in-tree:
|
||||
'docs_feedback_sphinxext',
|
||||
'pip_sphinxext',
|
||||
|
@ -314,3 +316,10 @@ docs_feedback_questions_list = (
|
|||
'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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
Render the unreleased pip version change notes on the news page in docs.
|
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue