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

Nick Coghlan webhook-mailer at python.org
Thu May 23 10:07:01 EDT 2019


https://github.com/python/cpython/commit/e788057a9188ff37e232729815dfda2529079420
commit: e788057a9188ff37e232729815dfda2529079420
branch: master
author: Nick Coghlan <ncoghlan at gmail.com>
committer: GitHub <noreply at github.com>
date: 2019-05-24T00:06:39+10:00
summary:

bpo-36797: Reduce levels of indirection in outdated distutils docs (#13462)

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 c56fafd68d8f..1f72a2554249 100644
--- a/Doc/distutils/index.rst
+++ b/Doc/distutils/index.rst
@@ -36,7 +36,6 @@ and extensions readily available to a wider audience.
    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`.



More information about the Python-checkins mailing list