From: Éric Araujo Date: Thu, 2 Jun 2011 14:43:25 +0000 (+0200) Subject: Merge packaging doc fix X-Git-Tag: v3.3.0a1~2183^2~13 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=acf71b89ffee503874178720dfb98b1651047891;p=python Merge packaging doc fix --- acf71b89ffee503874178720dfb98b1651047891 diff --cc Doc/install/index.rst index 0000000000,58b78350e7..bb2e9c58f1 mode 000000,100644..100644 --- a/Doc/install/index.rst +++ b/Doc/install/index.rst @@@ -1,0 -1,56 +1,56 @@@ + .. _packaging-install-index: + + ****************************** + Installing Python Projects + ****************************** + -:Author: Greg Ward and Packaging contributors ++:Author: The Fellowship of the Packaging + :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. diff --cc Doc/packaging/index.rst index 0e8081803e,1b597d744a..d3d0dec4de --- a/Doc/packaging/index.rst +++ b/Doc/packaging/index.rst @@@ -4,7 -4,7 +4,7 @@@ Distributing Python Projects ############################## - :Authors: The Fellowship of The Packaging -:Authors: Greg Ward, Anthony Baxter and Packaging contributors ++:Authors: The Fellowship of the Packaging :Email: distutils-sig@python.org :Release: |version| :Date: |today|