diff options
| author | Nick Coghlan <ncoghlan@gmail.com> | 2013-12-10 11:24:55 (GMT) |
|---|---|---|
| committer | Nick Coghlan <ncoghlan@gmail.com> | 2013-12-10 11:24:55 (GMT) |
| commit | b5c4fd0a964ec7d67e564e9e4a623d8b45aafa6b (patch) | |
| tree | a482eb3b4f001aadc23e5a96c475f53b1126b2e9 | |
| parent | 1f79cdfbfa3f53fb1aa3bb8998c463a5d2614795 (diff) | |
| download | cpython-b5c4fd0a964ec7d67e564e9e4a623d8b45aafa6b.zip cpython-b5c4fd0a964ec7d67e564e9e4a623d8b45aafa6b.tar.gz cpython-b5c4fd0a964ec7d67e564e9e4a623d8b45aafa6b.tar.bz2 | |
Issue #19407: add Python Packaging User Guide notes
The stdlib docs for package distribution and building extensions
are rather dated, and that isn't expected to change for 2.7 and
3.3.
The Python Packaging User Guide isn't complete either, but it's
already a much better road map for new users than the existing
stdlib docs.
| -rw-r--r-- | Doc/distutils/index.rst | 10 | ||||
| -rw-r--r-- | Doc/extending/index.rst | 9 | ||||
| -rw-r--r-- | Doc/install/index.rst | 18 |
3 files changed, 32 insertions, 5 deletions
diff --git a/Doc/distutils/index.rst b/Doc/distutils/index.rst index 1cd5f3c..1a6f04c 100644 --- a/Doc/distutils/index.rst +++ b/Doc/distutils/index.rst @@ -12,6 +12,16 @@ 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 very little overhead for build/release/install mechanics. +.. note:: + + This guide only covers the basic tools for building and distributing + extensions that are provided as part of this version of Python. Third + party tools offer easier to use and more secure alternatives. Refer to the + `quick recommendations section + <https://python-packaging-user-guide.readthedocs.org/en/latest/current.html>`__ + in the Python Packaging User Guide for more information. + + .. toctree:: :maxdepth: 2 :numbered: diff --git a/Doc/extending/index.rst b/Doc/extending/index.rst index 6112943..44a7f92 100644 --- a/Doc/extending/index.rst +++ b/Doc/extending/index.rst @@ -21,6 +21,15 @@ Python) that give the language its wide application range. For a detailed description of the whole Python/C API, see the separate :ref:`c-api-index`. +.. note:: + + This guide only covers the basic tools for creating extensions provided + as part of this version of CPython. Third party tools may offer simpler + alternatives. Refer to the `binary extensions section + <https://python-packaging-user-guide.readthedocs.org/en/latest/extensions.html>`__ + 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 index 738aaa1..779e923 100644 --- a/Doc/install/index.rst +++ b/Doc/install/index.rst @@ -20,12 +20,20 @@ Finally, it might be useful to include all the material from my "Care and Feeding of a Python Installation" talk in here somewhere. Yow! -.. topic:: Abstract +This document describes the Python Distribution Utilities ("Distutils") from the +end-user's point-of-view, describing how to extend the capabilities of a +standard Python installation by building and installing third-party Python +modules and extensions. - This document describes the Python Distribution Utilities ("Distutils") from the - end-user's point-of-view, describing how to extend the capabilities of a - standard Python installation by building and installing third-party Python - modules and extensions. + +.. note:: + + This guide only covers the basic tools for installing extensions that are + provided as part of this version of Python. Third party tools offer easier + to use and more secure alternatives. Refer to the + `quick recommendations section + <https://python-packaging-user-guide.readthedocs.org/en/latest/current.html>`__ + in the Python Packaging User Guide for more information. .. _inst-intro: |