Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b5c4fd0

Browse files
committed
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.
1 parent 1f79cdf commit b5c4fd0

3 files changed

Lines changed: 32 additions & 5 deletions

File tree

Doc/distutils/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ the module developer's point of view, describing how to use the Distutils to
1212
make Python modules and extensions easily available to a wider audience with
1313
very little overhead for build/release/install mechanics.
1414

15+
.. note::
16+
17+
This guide only covers the basic tools for building and distributing
18+
extensions that are provided as part of this version of Python. Third
19+
party tools offer easier to use and more secure alternatives. Refer to the
20+
`quick recommendations section
21+
<https://python-packaging-user-guide.readthedocs.org/en/latest/current.html>`__
22+
in the Python Packaging User Guide for more information.
23+
24+
1525
.. toctree::
1626
:maxdepth: 2
1727
:numbered:

Doc/extending/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ Python) that give the language its wide application range.
2121
For a detailed description of the whole Python/C API, see the separate
2222
:ref:`c-api-index`.
2323

24+
.. note::
25+
26+
This guide only covers the basic tools for creating extensions provided
27+
as part of this version of CPython. Third party tools may offer simpler
28+
alternatives. Refer to the `binary extensions section
29+
<https://python-packaging-user-guide.readthedocs.org/en/latest/extensions.html>`__
30+
in the Python Packaging User Guide for more information.
31+
32+
2433
.. toctree::
2534
:maxdepth: 2
2635
:numbered:

Doc/install/index.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,20 @@
2020
Finally, it might be useful to include all the material from my "Care
2121
and Feeding of a Python Installation" talk in here somewhere. Yow!
2222
23-
.. topic:: Abstract
23+
This document describes the Python Distribution Utilities ("Distutils") from the
24+
end-user's point-of-view, describing how to extend the capabilities of a
25+
standard Python installation by building and installing third-party Python
26+
modules and extensions.
2427

25-
This document describes the Python Distribution Utilities ("Distutils") from the
26-
end-user's point-of-view, describing how to extend the capabilities of a
27-
standard Python installation by building and installing third-party Python
28-
modules and extensions.
28+
29+
.. note::
30+
31+
This guide only covers the basic tools for installing extensions that are
32+
provided as part of this version of Python. Third party tools offer easier
33+
to use and more secure alternatives. Refer to the
34+
`quick recommendations section
35+
<https://python-packaging-user-guide.readthedocs.org/en/latest/current.html>`__
36+
in the Python Packaging User Guide for more information.
2937

3038

3139
.. _inst-intro:

0 commit comments

Comments
 (0)