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

Skip to content

Commit 55729fe

Browse files
merwokmerwok
committed
Packaging doc: Add missing index file, improve main page description.
Also promote notices from distutils doc to deprecation boxes.
1 parent 8c86ecd commit 55729fe

4 files changed

Lines changed: 71 additions & 14 deletions

File tree

‎Doc/distutils/index.rst‎

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

17+
.. deprecated:: 3.3
18+
:mod:`packaging` replaces Distutils. See :ref:`packaging-index` and
19+
:ref:`packaging-install-index`.
20+
1721
.. toctree::
1822
:maxdepth: 2
1923
:numbered:
@@ -36,9 +40,3 @@ following the above guidelines:
3640
.. toctree::
3741

3842
install.rst
39-
40-
41-
.. seealso::
42-
43-
:ref:`packaging-index` and :ref:`packaging-install-index`
44-
Documentation of Packaging, the new version of Distutils.

‎Doc/install/index.rst‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _packaging-install-index:
2+
3+
******************************
4+
Installing Python Projects
5+
******************************
6+
7+
:Author: Greg Ward and Packaging contributors
8+
:Release: |version|
9+
:Date: |today|
10+
11+
.. TODO: Fill in XXX comments
12+
13+
.. The audience for this document includes people who don't know anything
14+
about Python and aren't about to learn the language just in order to
15+
install and maintain it for their users, i.e. system administrators.
16+
Thus, I have to be sure to explain the basics at some point:
17+
sys.path and PYTHONPATH at least. Should probably give pointers to
18+
other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc.
19+
20+
Finally, it might be useful to include all the material from my "Care
21+
and Feeding of a Python Installation" talk in here somewhere. Yow!
22+
23+
.. topic:: Abstract
24+
25+
This document describes Packaging from the end-user's point of view: it
26+
explains how to extend the functionality of a standard Python installation by
27+
building and installing third-party Python modules and applications.
28+
29+
30+
This guide is split into a simple overview followed by a longer presentation of
31+
the :program:`pysetup` script, the Python package management tool used to
32+
build, distribute, search for, install, remove and list Python distributions.
33+
34+
.. TODO integrate install and pysetup instead of duplicating
35+
36+
.. toctree::
37+
:maxdepth: 2
38+
:numbered:
39+
40+
install
41+
pysetup
42+
pysetup-config
43+
pysetup-servers
44+
45+
46+
.. seealso::
47+
48+
:ref:`packaging-index`
49+
The manual for developers of Python projects who want to package and
50+
distribute them. This describes how to use :mod:`packaging` to make
51+
projects easily found and added to an existing Python installation.
52+
53+
:mod:`packaging`
54+
A library reference for developers of packaging tools wanting to use
55+
standalone building blocks like :mod:`~packaging.version` or
56+
:mod:`~packaging.metadata`, or extend Packaging itself.

‎Doc/library/distutils.rst‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,24 @@ additional modules into a Python installation. The new modules may be either
1212
100%-pure Python, or may be extension modules written in C, or may be
1313
collections of Python packages which include modules coded in both Python and C.
1414

15-
This package is discussed in two separate chapters:
15+
.. deprecated:: 3.3
16+
:mod:`packaging` replaces Distutils. See :ref:`packaging-index` and
17+
:ref:`packaging-install-index`.
1618

1719

20+
User documentation and API reference are provided in another document:
21+
1822
.. seealso::
1923

2024
:ref:`distutils-index`
2125
The manual for developers and packagers of Python modules. This describes
2226
how to prepare :mod:`distutils`\ -based packages so that they may be
23-
easily installed into an existing Python installation.
27+
easily installed into an existing Python installation. If also contains
28+
instructions for end-users wanting to install a distutils-based package,
29+
:ref:`install-index`.
2430

25-
:ref:`install-index`
26-
An "administrators" manual which includes information on installing
27-
modules into an existing Python installation. You do not need to be a
28-
Python programmer to read this manual.
2931

32+
.. trick to silence a Sphinx warning
3033
3134
.. toctree::
3235
:hidden:

‎Doc/tools/sphinxext/indexcontent.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<p class="biglink"><a class="biglink" href="{{ pathto("c-api/index") }}">Python/C API</a><br/>
2222
<span class="linkdescr">reference for C/C++ programmers</span></p>
2323
<p class="biglink"><a class="biglink" href="{{ pathto("install/index") }}">Installing Python Projects</a><br/>
24-
<span class="linkdescr">information for installers &amp; sys-admins</span></p>
24+
<span class="linkdescr">finding and installing modules and applications</span></p>
2525
<p class="biglink"><a class="biglink" href="{{ pathto("packaging/index") }}">Distributing Python Projects</a><br/>
26-
<span class="linkdescr">sharing modules with others</span></p>
26+
<span class="linkdescr">packaging and distributing modules and applications</span></p>
2727
<p class="biglink"><a class="biglink" href="{{ pathto("documenting/index") }}">Documenting Python</a><br/>
2828
<span class="linkdescr">guide for documentation authors</span></p>
2929
<p class="biglink"><a class="biglink" href="{{ pathto("faq/index") }}">FAQs</a><br/>

0 commit comments

Comments
 (0)