From bf84d90b4dccb9fc52c8fe385e52f7a63e9a5535 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 13 Aug 2013 07:36:48 -0400 Subject: Add Intersphinx for Beaker, clean up some broken references, change from pip to virtualenv (and give an explanation), explain virtualenv on Python 2.7. --- docs/quick_tour.rst | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) (limited to 'docs/quick_tour.rst') diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index cb07826cf..ba2a517ef 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -29,15 +29,25 @@ area in place. For Python 3.3: $ source env33/bin/activate $ wget https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py -O - | python -We make a :term:`virtualenv` then activate it. We then get Python -packaging tools installed. +We make a :term:`virtualenv` then activate it. Next we download +Python's packaging support and install it, giving us the +``easy_install`` command-line script for adding new packages. Python +2.7 users will need to use ``virtualenv`` instead of ``pyvenv`` to make +their virtual environment. + +.. note:: + + Why ``easy_install`` and not ``pip``? Pyramid encourages use of + namespace packages which, until recently, ``pip`` didn't permit. + Also, Pyramid has some optional C extensions for performance. With + ``easy_install``, Windows users can get these extensions without + needing a C compiler. .. seealso:: See Also: Python 3's :mod:`venv module `, the ``setuptools`` `installation instructions `_, - documentation for `pip `_, - and - Pyramid's :ref:`Before You Install ` + `easy_install help `_, + and Pyramid's :ref:`Before You Install `. Pyramid Installation ==================== @@ -722,8 +732,7 @@ Jinja2 template: .. seealso:: See Also: :ref:`sessions_chapter`, :ref:`flash_messages`, :ref:`session_module`, and - `Beaker sessioning middleware - `_ + :ref:`Beaker sessioning middleware ` Databases ========= @@ -771,8 +780,7 @@ of the system, can then easily get at the data thanks to SQLAlchemy: .. seealso:: See Also: `SQLAlchemy `_, :ref:`making_a_console_script`, :ref:`bfg_sql_wiki_tutorial`, and - `Application Transactions With pyramid_tm - `_ + :ref:`Application Transactions With pyramid_tm ` Forms ===== @@ -823,10 +831,7 @@ We'd like to handle form submission, validation, and saving: Deform and Colander provide a very flexible combination for forms, widgets, schemas, and validation. Recent versions of Deform also -include a -`retail mode `_ -for gaining Deform +include a :ref:`retail mode ` for gaining Deform features on custom forms. Also, the ``deform_bootstrap`` Pyramid add-on restyles the stock Deform @@ -834,8 +839,8 @@ widgets using attractive CSS from Bootstrap and more powerful widgets from Chosen. .. seealso:: See Also: - `Deform `_, - `Colander `_, and + :ref:`Deform `, + :ref:`Colander `, and `deform_bootstrap `_ Conclusion -- cgit v1.2.3