diff options
author | Éric Araujo <merwok@netwok.org> | 2011-06-02 13:45:25 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@netwok.org> | 2011-06-02 13:45:25 (GMT) |
commit | 55729fe7189ab3d21c14cc6be6896ca4f0ebad65 (patch) | |
tree | 7a1f161ff45f5036b848c47556d2c979379cfcdf /Doc/install | |
parent | 8c86ecdab52528ed7457872c99252d0df94c7157 (diff) | |
download | cpython-55729fe7189ab3d21c14cc6be6896ca4f0ebad65.zip cpython-55729fe7189ab3d21c14cc6be6896ca4f0ebad65.tar.gz cpython-55729fe7189ab3d21c14cc6be6896ca4f0ebad65.tar.bz2 |
Packaging doc: Add missing index file, improve main page description.
Also promote notices from distutils doc to deprecation boxes.
Diffstat (limited to 'Doc/install')
-rw-r--r-- | Doc/install/index.rst | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/Doc/install/index.rst b/Doc/install/index.rst new file mode 100644 index 0000000..58b7835 --- /dev/null +++ b/Doc/install/index.rst @@ -0,0 +1,56 @@ +.. _packaging-install-index: + +****************************** + Installing Python Projects +****************************** + +:Author: Greg Ward and Packaging contributors +:Release: |version| +:Date: |today| + +.. TODO: Fill in XXX comments + +.. 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. + Thus, I have to be sure to explain the basics at some point: + sys.path and PYTHONPATH at least. Should probably give pointers to + other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc. + + 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 Packaging from the end-user's point of view: it + explains how to extend the functionality of a standard Python installation by + building and installing third-party Python modules and applications. + + +This guide is split into a simple overview followed by a longer presentation of +the :program:`pysetup` script, the Python package management tool used to +build, distribute, search for, install, remove and list Python distributions. + +.. TODO integrate install and pysetup instead of duplicating + +.. toctree:: + :maxdepth: 2 + :numbered: + + install + pysetup + pysetup-config + pysetup-servers + + +.. 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. + + :mod:`packaging` + A library reference for developers of packaging tools wanting to use + standalone building blocks like :mod:`~packaging.version` or + :mod:`~packaging.metadata`, or extend Packaging itself. |