diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-05-23 07:19:41 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-05-23 07:19:41 -0700 |
commit | a3488e5902f5c26e5cc289aec2518e7b5058e5d1 (patch) | |
tree | f7ed5f08dbcd7dc87168055dbca630ee0daa9f69 /Doc | |
parent | 7cc47e9c19b7d67c8f08df15a413d14cf69f45da (diff) | |
download | cpython-git-a3488e5902f5c26e5cc289aec2518e7b5058e5d1.tar.gz |
bpo-36797: Reduce levels of indirection in outdated distutils docs (GH-13462)
(cherry picked from commit e788057a9188ff37e232729815dfda2529079420)
Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/distributing/index.rst | 12 | ||||
-rw-r--r-- | Doc/distutils/index.rst | 1 | ||||
-rw-r--r-- | Doc/distutils/packageindex.rst | 7 | ||||
-rw-r--r-- | 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 5dd14b1f7a..2e46c7ac86 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 d6f7640fcb..aaf4536dfa 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 f74c4396e5..ccb9a598b2 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 4bce6997f9..4c391cab07 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`. |