[Python-checkins] cpython (3.5): Issue #26014: Update 3.x packaging documentation:

ned.deily python-checkins at python.org
Sun Jun 5 20:40:42 EDT 2016


https://hg.python.org/cpython/rev/f5fd646b265b
changeset:   101758:f5fd646b265b
branch:      3.5
parent:      101755:d91b951e676f
user:        Ned Deily <nad at python.org>
date:        Sun Jun 05 17:38:48 2016 -0700
summary:
  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

(original patch by Susan Sun)

files:
  Doc/distributing/index.rst |  2 +-
  Doc/distutils/index.rst    |  6 +++++-
  Doc/install/index.rst      |  5 +++++
  Doc/library/distutils.rst  |  2 +-
  Misc/NEWS                  |  4 ++++
  5 files changed, 16 insertions(+), 3 deletions(-)


diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst
--- a/Doc/distributing/index.rst
+++ b/Doc/distributing/index.rst
@@ -61,7 +61,7 @@
   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
diff --git a/Doc/distutils/index.rst b/Doc/distutils/index.rst
--- a/Doc/distutils/index.rst
+++ b/Doc/distutils/index.rst
@@ -7,6 +7,11 @@
 :Authors: Greg Ward, Anthony Baxter
 :Email: distutils-sig at python.org
 
+.. 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
@@ -20,7 +25,6 @@
    recommendations section <https://packaging.python.org/en/latest/current/>`__
    in the Python Packaging User Guide for more information.
 
-
 .. toctree::
    :maxdepth: 2
    :numbered:
diff --git a/Doc/install/index.rst b/Doc/install/index.rst
--- a/Doc/install/index.rst
+++ b/Doc/install/index.rst
@@ -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.
diff --git a/Doc/library/distutils.rst b/Doc/library/distutils.rst
--- a/Doc/library/distutils.rst
+++ b/Doc/library/distutils.rst
@@ -15,7 +15,7 @@
 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
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -543,6 +543,10 @@
 - 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
 -----
 

-- 
Repository URL: https://hg.python.org/cpython


More information about the Python-checkins mailing list