diff options
author | Éric Araujo <merwok@netwok.org> | 2011-06-01 18:42:49 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@netwok.org> | 2011-06-01 18:42:49 (GMT) |
commit | 3a9f58f6b3938823328374f34a3b52a167fed871 (patch) | |
tree | 10cc586248124e3c921dd921602e9730f7064397 /Doc/library/packaging.rst | |
parent | a003af1ce9d008e03371b3d16c4d6361961c2e78 (diff) | |
download | cpython-3a9f58f6b3938823328374f34a3b52a167fed871.zip cpython-3a9f58f6b3938823328374f34a3b52a167fed871.tar.gz cpython-3a9f58f6b3938823328374f34a3b52a167fed871.tar.bz2 |
Add documentation for the packaging module.
This updates the user guide to refer to Packaging instead of Distutils.
Some files still require an update.
Diffstat (limited to 'Doc/library/packaging.rst')
-rw-r--r-- | Doc/library/packaging.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/Doc/library/packaging.rst b/Doc/library/packaging.rst new file mode 100644 index 0000000..5bf2c06 --- /dev/null +++ b/Doc/library/packaging.rst @@ -0,0 +1,78 @@ +:mod:`packaging` --- Packaging support +====================================== + +.. module:: packaging + :synopsis: Packaging system and building blocks for other packaging systems. +.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>, distutils and packaging + contributors + + +The :mod:`packaging` package provides support for building, packaging, +distributing and installing additional projects into a Python installation. +Projects may include Python modules, extension modules, packages and scripts. +:mod:`packaging` also provides building blocks for other packaging systems +that are not tied to the command system. + +This manual is the reference documentation for those standalone building +blocks and for extending Packaging. If you're looking for the user-centric +guides to install a project or package your own code, head to `See also`__. + + +Building blocks +--------------- + +.. toctree:: + :maxdepth: 2 + :numbered: + + packaging-misc + packaging.version + packaging.metadata + packaging.database + packaging.depgraph + packaging.pypi + packaging.pypi.dist + packaging.pypi.simple + packaging.pypi.xmlrpc + packaging.install + + +The command machinery +--------------------- + +.. toctree:: + :maxdepth: 2 + :numbered: + + packaging.dist + packaging.command + packaging.compiler + packaging.fancy_getopt + + +Other utilities +---------------- + +.. toctree:: + :maxdepth: 2 + :numbered: + + packaging.util + packaging.tests.pypi_server + +.. XXX missing: compat config create (dir_util) run pypi.{base,mirrors} + + +.. __: + +.. seealso:: + + :ref:`packaging-index` + The manual for developers of Python projects who want to package and + distribute them. This describes how to use :mod:`packaging` to make + projects easily found and added to an existing Python installation. + + :ref:`packaging-install-index` + A user-centered manual which includes information on adding projects + into an existing Python installation. You do not need to be a Python + programmer to read this manual. |