Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ncoghlan merged 1 commit into from
May 23, 2019
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions Doc/distributing/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions Doc/distutils/packageindex.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
View file
Open in desktop
Original file line number Diff line number Diff line change
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`.