From: Mike Bayer Date: Tue, 6 Dec 2011 19:28:54 +0000 (-0500) Subject: add docs regarding flags only working with setuptools/distribute, [ticket:2341] X-Git-Tag: rel_0_7_4~13 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e8180bb7180b9ea1e14fa97c6de3745596cb2c90;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git add docs regarding flags only working with setuptools/distribute, [ticket:2341] --- diff --git a/doc/build/intro.rst b/doc/build/intro.rst index 39f02b3dd3..52180a91bb 100644 --- a/doc/build/intro.rst +++ b/doc/build/intro.rst @@ -99,6 +99,9 @@ SQLAlchemy supports installation using standard Python "distutils" or rides on top of ``setuptools`` or ``distribute``, replacing the usage of ``easy_install``. It is often preferred for its simpler mode of usage. +.. note:: It is strongly recommended that either ``setuptools`` or ``distribute`` be installed. + Python's built-in ``distutils`` lacks many widely used installation features. + Install via easy_install or pip ------------------------------- @@ -138,6 +141,11 @@ pass the flag ``--without-cextensions`` to the ``setup.py`` script:: python setup.py --without-cextensions install +.. note:: The ``--without-cextensions`` flag is available **only** if ``setuptools`` + or ``distribute`` is installed. It is not available on a plain Python ``distutils`` + installation. The library will still install without the C extensions if they + cannot be built, however. + Installing on Python 3 ----------------------------------