[Python-checkins] bpo-36797: Reduce levels of indirection in outdated distutils docs (GH-13462)

Thu May 23 10:19:46 EDT 2019

https://github.com/python/cpython/commit/a3488e5902f5c26e5cc289aec2518e7b5058e5d1
commit: a3488e5902f5c26e5cc289aec2518e7b5058e5d1
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019年05月23日T07:19:41-07:00
summary:
bpo-36797: Reduce levels of indirection in outdated distutils docs (GH-13462)
(cherry picked from commit e788057a9188ff37e232729815dfda2529079420)
Co-authored-by: Nick Coghlan <ncoghlan at gmail.com>
files:
M Doc/distributing/index.rst
M Doc/distutils/index.rst
M Doc/distutils/packageindex.rst
M Doc/distutils/uploading.rst

diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst
index 5dd14b1f7a60..2e46c7ac8635 100644
--- a/Doc/distributing/index.rst
+++ b/Doc/distributing/index.rst
@@ -113,11 +113,17 @@ recommended tools`_.
 
 .. _currently recommended tools: https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations
 
-Reading the guide
-=================
+.. index::
+ single: Python Package Index (PyPI)
+ single: PyPI; (see Python Package Index (PyPI))
+
+.. _publishing-python-packages:
+
+Reading the Python Packaging User Guide
+=======================================
 
 The Python Packaging User Guide covers the various key steps and elements
-involved in creating a project:
+involved in creating and publishing a project:
 
 * `Project structure`_
 * `Building and packaging the project`_
diff --git a/Doc/distutils/index.rst b/Doc/distutils/index.rst
index d6f7640fcb68..aaf4536dfa54 100644
--- a/Doc/distutils/index.rst
+++ b/Doc/distutils/index.rst
@@ -34,7 +34,6 @@ very little overhead for build/release/install mechanics.
 configfile.rst
 sourcedist.rst
 builtdist.rst
- packageindex.rst
 examples.rst
 extending.rst
 commandref.rst
diff --git a/Doc/distutils/packageindex.rst b/Doc/distutils/packageindex.rst
index f74c4396e545..ccb9a598b2b7 100644
--- a/Doc/distutils/packageindex.rst
+++ b/Doc/distutils/packageindex.rst
@@ -1,6 +1,4 @@
-.. index::
- single: Python Package Index (PyPI)
- single: PyPI; (see Python Package Index (PyPI))
+:orphan:
 
 .. _package-index:
 
@@ -12,6 +10,7 @@ The `Python Package Index (PyPI)`_ stores metadata describing distributions
 packaged with distutils and other publishing tools, as well the distribution
 archives themselves.
 
-Detailed instructions on using PyPI at :ref:`distributing-index`.
+References to up to date PyPI documentation can be found at
+:ref:`publishing-python-packages`.
 
 .. _Python Package Index (PyPI): https://pypi.org
diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst
index 4bce6997f9f8..4c391cab072e 100644
--- a/Doc/distutils/uploading.rst
+++ b/Doc/distutils/uploading.rst
@@ -4,4 +4,5 @@
 Uploading Packages to the Package Index
 ***************************************
 
-The contents of this page have moved to the section :ref:`package-index`.
+References to up to date PyPI documentation can be found at
+:ref:`publishing-python-packages`.
