summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2011-12-06 14:28:54 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2011-12-06 14:28:54 -0500
commite8180bb7180b9ea1e14fa97c6de3745596cb2c90 (patch)
tree3b264597f47f58d637aee39433189dfd2d4c3ac4 /doc
parenta8dc787ff02490da17e8704ca564bf0c6b46c04d (diff)
downloadsqlalchemy-e8180bb7180b9ea1e14fa97c6de3745596cb2c90.tar.gz
add docs regarding flags only working with setuptools/distribute, [ticket:2341]
Diffstat (limited to 'doc')
-rw-r--r--doc/build/intro.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/build/intro.rst b/doc/build/intro.rst
index 39f02b3dd..52180a91b 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
----------------------------------