From e788057a9188ff37e232729815dfda2529079420 Mon Sep 17 00:00:00 2001 From: Nick Coghlan Date: Fri, 24 May 2019 00:06:39 +1000 Subject: bpo-36797: Reduce levels of indirection in outdated distutils docs (#13462) --- Doc/distributing/index.rst | 12 +++++++++--- Doc/distutils/index.rst | 1 - Doc/distutils/packageindex.rst | 7 +++---- Doc/distutils/uploading.rst | 3 ++- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 5dd14b1..2e46c7a 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 c56fafd..1f72a25 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 f74c439..ccb9a59 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 4bce699..4c391ca 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`. -- cgit v0.12