Skip to content

Commit

Permalink
bpo-36797: Reduce levels of indirection in outdated distutils docs (G…
Browse files Browse the repository at this point in the history
…H-13462)

(cherry picked from commit e788057)

Co-authored-by: Nick Coghlan <ncoghlan@gmail.com>
  • Loading branch information
miss-islington and ncoghlan committed May 23, 2019
1 parent 7cc47e9 commit a3488e5
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 9 deletions.
12 changes: 9 additions & 3 deletions Doc/distributing/index.rst
Expand Up @@ -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`_
Expand Down
1 change: 0 additions & 1 deletion Doc/distutils/index.rst
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions Doc/distutils/packageindex.rst
@@ -1,6 +1,4 @@
.. index::
single: Python Package Index (PyPI)
single: PyPI; (see Python Package Index (PyPI))
:orphan:

.. _package-index:

Expand All @@ -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
3 changes: 2 additions & 1 deletion Doc/distutils/uploading.rst
Expand Up @@ -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`.

0 comments on commit a3488e5

Please sign in to comment.