Skip to content

Commit

Permalink
Issue python#26014: Update 3.x packaging documentation:
Browse files Browse the repository at this point in the history
- "See also" links to the new docs are now provided in the legacy pages
- links to setuptools documentation have been updated

(original patch by Susan Sun)
  • Loading branch information
ned-deily committed Jun 6, 2016
1 parent 3f0ee83 commit 8f5798e
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Doc/distributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Key terms
extensions, to be installed on a system without needing to be built
locally.

.. _setuptools: https://setuptools.pypa.io/en/latest/setuptools.html
.. _setuptools: https://setuptools.readthedocs.io/en/latest/
.. _wheel: https://wheel.readthedocs.org

Open source licensing and collaboration
Expand Down
6 changes: 5 additions & 1 deletion Doc/distutils/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
:Authors: Greg Ward, Anthony Baxter
:Email: [email protected]

.. seealso::

:ref:`distributing-index`
The up to date module distribution documentations

This document describes the Python Distribution Utilities ("Distutils") from
the module developer's point of view, describing how to use the Distutils to
make Python modules and extensions easily available to a wider audience with
Expand All @@ -20,7 +25,6 @@ very little overhead for build/release/install mechanics.
recommendations section <https://packaging.python.org/en/latest/current/>`__
in the Python Packaging User Guide for more information.


.. toctree::
:maxdepth: 2
:numbered:
Expand Down
5 changes: 5 additions & 0 deletions Doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@

.. TODO: Fill in XXX comments
.. seealso::

:ref:`installing-index`
The up to date module installation documentations

.. The audience for this document includes people who don't know anything
about Python and aren't about to learn the language just in order to
install and maintain it for their users, i.e. system administrators.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/distutils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ collections of Python packages which include modules coded in both Python and C.
Most Python users will *not* want to use this module directly, but instead
use the cross-version tools maintained by the Python Packaging Authority. In
particular,
`setuptools <https://setuptools.pypa.io/en/latest/setuptools.html>`__ is an
`setuptools <https://setuptools.readthedocs.io/en/latest/>`__ is an
enhanced alternative to :mod:`distutils` that provides:

* support for declaring project dependencies
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,10 @@ Documentation
- Issue #25500: Fix documentation to not claim that __import__ is searched for
in the global scope.

- Issue #26014: Update 3.x packaging documentation:
* "See also" links to the new docs are now provided in the legacy pages
* links to setuptools documentation have been updated

Tests
-----

Expand Down

0 comments on commit 8f5798e

Please sign in to comment.