McSinyx
/
pip
mirror of https://github.com/pypa/pip
1
1
Fork 0
Code Issues Releases Activity

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:
Pradyun Gedam 2020-12-26 10:50:10 +00:00 committed by GitHub
parent a48ad5385b 0ddfe08828
commit c383ec3b41
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/html/conf.py
View File

@ -11,6 +11,7 @@
import glob import glob
import os import os
import pathlib
import re import re
import sys import sys
@ -34,6 +35,7 @@ extensions = [
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
# third-party: # third-party:
'sphinx_inline_tabs', 'sphinx_inline_tabs',
'sphinxcontrib.towncrier',
# in-tree: # in-tree:
'docs_feedback_sphinxext', 'docs_feedback_sphinxext',
'pip_sphinxext', 'pip_sphinxext',
@ -314,3 +316,10 @@ docs_feedback_questions_list = (
'What content was useful?', 'What content was useful?',
'What content was not 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
docs/html/news.rst
View File

@ -7,4 +7,6 @@ Changelog
Major and minor releases of pip also include changes listed within Major and minor releases of pip also include changes listed within
prior beta releases. prior beta releases.
.. towncrier-draft-entries:: |release|, unreleased as on
.. include:: ../../NEWS.rst .. include:: ../../NEWS.rst

1
news/9172.doc.rst Normal file
View File

@ -0,0 +1 @@
Render the unreleased pip version change notes on the news page in docs.

1
tools/requirements/docs.txt
View File

@ -1,6 +1,7 @@
sphinx == 3.2.1 sphinx == 3.2.1
furo furo
sphinx-inline-tabs sphinx-inline-tabs
sphinxcontrib-towncrier
# `docs.pipext` uses pip's internals to generate documentation. So, we install # `docs.pipext` uses pip's internals to generate documentation. So, we install
# the current directory to make it work. # the current directory to make it work.