summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2013-03-25 05:05:07 -0400
committerChris McDonough <chrism@plope.com>2013-03-25 05:05:07 -0400
commitdacbe656d8851580234214fb655b60d24f5800fb (patch)
treef0c39c064fd55b1141c7e96a62ae80a290acd8ff /docs
parent0bda2652728ae33ea37adc1f7f2f382e0ebbf4df (diff)
parentb4c0d4f0574b45c88f66530548ecaa7d6ad0baef (diff)
downloadpyramid-dacbe656d8851580234214fb655b60d24f5800fb.tar.gz
pyramid-dacbe656d8851580234214fb655b60d24f5800fb.tar.bz2
pyramid-dacbe656d8851580234214fb655b60d24f5800fb.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py1
-rw-r--r--docs/narr/install.rst2
-rw-r--r--docs/narr/muchadoabouttraversal.rst18
-rw-r--r--docs/narr/sessions.rst43
-rw-r--r--docs/tutorials/wiki2/authorization.rst8
-rw-r--r--docs/tutorials/wiki2/definingviews.rst10
-rw-r--r--docs/tutorials/wiki2/installation.rst60
7 files changed, 74 insertions, 68 deletions
diff --git a/docs/conf.py b/docs/conf.py
index eff6db488..69d00cdaa 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -55,6 +55,7 @@ extensions = [
# Looks for objects in external projects
intersphinx_mapping = {
+ 'webob': ('http://docs.webob.org/en/latest', None),
'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
'who': ('http://docs.repoze.org/who/latest', None),
'python': ('http://docs.python.org', None),
diff --git a/docs/narr/install.rst b/docs/narr/install.rst
index 7f4742ee2..8fc63f3a4 100644
--- a/docs/narr/install.rst
+++ b/docs/narr/install.rst
@@ -341,7 +341,7 @@ for both versions are included below.
Windows Using Python 2
~~~~~~~~~~~~~~~~~~~~~~
-#. Install, or find the most recent `Python 2.7.x version
+#. Install the most recent `Python 2.7.x version
<http://www.python.org/download/>`_ for your system.
#. Install the `Python for Windows extensions
diff --git a/docs/narr/muchadoabouttraversal.rst b/docs/narr/muchadoabouttraversal.rst
index 40d498391..483b1bb16 100644
--- a/docs/narr/muchadoabouttraversal.rst
+++ b/docs/narr/muchadoabouttraversal.rst
@@ -168,18 +168,12 @@ hood, when ``adict`` is a dictionary-like object, Python translates
``adict['a']`` to ``adict.__getitem__('a')``. Try doing this in a Python
interpreter prompt if you don't believe us:
-.. code-block:: text
- :linenos:
-
- Python 2.4.6 (#2, Apr 29 2010, 00:31:48)
- [GCC 4.4.3] on linux2
- Type "help", "copyright", "credits" or "license" for more information.
- >>> adict = {}
- >>> adict['a'] = 1
- >>> adict['a']
- 1
- >>> adict.__getitem__('a')
- 1
+>>> adict = {}
+>>> adict['a'] = 1
+>>> adict['a']
+1
+>>> adict.__getitem__('a')
+1
The dictionary-like root object stores the ids of all of its subresources as
diff --git a/docs/narr/sessions.rst b/docs/narr/sessions.rst
index fa4affd8a..c4f4b5f07 100644
--- a/docs/narr/sessions.rst
+++ b/docs/narr/sessions.rst
@@ -252,25 +252,19 @@ that were added to the flash queue, and empties the queue.
.. method:: pop_flash(queue='')
-.. code-block:: python
- :linenos:
-
- >>> request.session.flash('info message')
- >>> request.session.pop_flash()
- ['info message']
+>>> request.session.flash('info message')
+>>> request.session.pop_flash()
+['info message']
Calling ``session.pop_flash()`` again like above without a corresponding call
to ``session.flash()`` will return an empty list, because the queue has already
been popped.
-.. code-block:: python
- :linenos:
-
- >>> request.session.flash('info message')
- >>> request.session.pop_flash()
- ['info message']
- >>> request.session.pop_flash()
- []
+>>> request.session.flash('info message')
+>>> request.session.pop_flash()
+['info message']
+>>> request.session.pop_flash()
+[]
.. index::
single: session.peek_flash
@@ -285,18 +279,15 @@ popped from flash storage.
.. method:: peek_flash(queue='')
-.. code-block:: python
- :linenos:
-
- >>> request.session.flash('info message')
- >>> request.session.peek_flash()
- ['info message']
- >>> request.session.peek_flash()
- ['info message']
- >>> request.session.pop_flash()
- ['info message']
- >>> request.session.peek_flash()
- []
+>>> request.session.flash('info message')
+>>> request.session.peek_flash()
+['info message']
+>>> request.session.peek_flash()
+['info message']
+>>> request.session.pop_flash()
+['info message']
+>>> request.session.peek_flash()
+[]
.. index::
single: preventing cross-site request forgery attacks
diff --git a/docs/tutorials/wiki2/authorization.rst b/docs/tutorials/wiki2/authorization.rst
index 5ede26920..01c301e74 100644
--- a/docs/tutorials/wiki2/authorization.rst
+++ b/docs/tutorials/wiki2/authorization.rst
@@ -381,21 +381,21 @@ We can finally examine our application in a browser (See
:ref:`wiki2-start-the-application`). Launch a browser and visit
each of the following URLs, check that the result is as expected:
-- ``http://localhost:6543/`` invokes the
+- http://localhost:6543/ invokes the
``view_wiki`` view. This always redirects to the ``view_page`` view
of the FrontPage page object. It is executable by any user.
-- ``http://localhost:6543/FrontPage`` invokes
+- http://localhost:6543/FrontPage invokes
the ``view_page`` view of the FrontPage page object.
-- ``http://localhost:6543/FrontPage/edit_page``
+- http://localhost:6543/FrontPage/edit_page
invokes the edit view for the FrontPage object. It is executable by
only the ``editor`` user. If a different user (or the anonymous
user) invokes it, a login form will be displayed. Supplying the
credentials with the username ``editor``, password ``editor`` will
display the edit page form.
-- ``http://localhost:6543/add_page/SomePageName``
+- http://localhost:6543/add_page/SomePageName
invokes the add view for a page. It is executable by only
the ``editor`` user. If a different user (or the anonymous user)
invokes it, a login form will be displayed. Supplying the
diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 53f8e569c..a1e2313f3 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -346,20 +346,20 @@ We can finally examine our application in a browser (See
:ref:`wiki2-start-the-application`). Launch a browser and visit
each of the following URLs, check that the result is as expected:
-- ``http://localhost:6543`` in a browser invokes the
+- http://localhost:6543 in a browser invokes the
``view_wiki`` view. This always redirects to the ``view_page`` view
of the FrontPage page object.
-- ``http://localhost:6543/FrontPage`` in a browser invokes
+- http://localhost:6543/FrontPage in a browser invokes
the ``view_page`` view of the front page object.
-- ``http://localhost:6543/FrontPage/edit_page`` in a browser
+- http://localhost:6543/FrontPage/edit_page in a browser
invokes the edit view for the front page object.
-- ``http://localhost:6543/add_page/SomePageName`` in a
+- http://localhost:6543/add_page/SomePageName in a
browser invokes the add view for a page.
-- To generate an error, visit ``http://localhost:6543/foobars/edit_page`` which
+- To generate an error, visit http://localhost:6543/foobars/edit_page which
will generate a ``NoResultFound: No row was found for one()`` error.
You'll see an interactive traceback facility provided
by :term:`pyramid_debugtoolbar`.
diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst
index 9590e4abe..17788cdde 100644
--- a/docs/tutorials/wiki2/installation.rst
+++ b/docs/tutorials/wiki2/installation.rst
@@ -20,7 +20,8 @@ Next let's create a `virtualenv` workspace for our project. We will
use the `VENV` environment variable instead of absolute path of the
virtual environment.
-**On UNIX:**
+On UNIX
+^^^^^^^
.. code-block:: text
@@ -29,7 +30,8 @@ virtual environment.
New python executable in /home/foo/env/bin/python
Installing setuptools.............done.
-**On Windows**:
+On Windows
+^^^^^^^^^^
Set the `VENV` environment variable.
@@ -55,13 +57,15 @@ Python 3.2:
Install Pyramid Into the Virtual Python Environment
---------------------------------------------------
-**On UNIX:**
+On UNIX
+^^^^^^^
.. code-block:: text
$ $VENV/bin/easy_install pyramid
-**On Windows**:
+On Windows
+^^^^^^^^^^
.. code-block:: text
@@ -88,13 +92,15 @@ Change Directory to Your Virtual Python Environment
Change directory to the ``pyramidtut`` directory.
-**On UNIX**:
+On UNIX
+^^^^^^^
.. code-block:: text
$ cd pyramidtut
-**On Windows**:
+On Windows
+^^^^^^^^^^
.. code-block:: text
@@ -123,13 +129,15 @@ required files. For example, `pcreate` creates the
The below instructions assume your current working directory is the
"virtualenv" named "pyramidtut".
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ $VENV/bin/pcreate -s alchemy tutorial
-**On Windows**:
+On Windows
+----------
.. code-block:: text
@@ -152,14 +160,16 @@ the project as a development egg in your workspace using the
directory you created in :ref:`sql_making_a_project`, and run the
``setup.py develop`` command using the virtualenv Python interpreter.
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ cd tutorial
$ $VENV/bin/python setup.py develop
-**On Windows**:
+On Windows
+----------
.. code-block:: text
@@ -180,13 +190,15 @@ Running the Tests
After you've installed the project in development mode, you may run
the tests for the project.
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ $VENV/bin/python setup.py test -q
-**On Windows**:
+On Windows
+----------
.. code-block:: text
@@ -212,13 +224,15 @@ tests.
To get this functionality working, we'll need to install the ``nose`` and
``coverage`` packages into our ``virtualenv``:
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ $VENV/bin/easy_install nose coverage
-**On Windows**:
+On Windows
+----------
.. code-block:: text
@@ -227,13 +241,15 @@ To get this functionality working, we'll need to install the ``nose`` and
Once ``nose`` and ``coverage`` are installed, we can actually run the
coverage tests.
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage
-**On Windows**:
+On Windows
+----------
.. code-block:: text
@@ -271,13 +287,15 @@ script` to initialize our database.
Type the following command, make sure you are still in the ``tutorial``
directory (the directory with a ``development.ini`` in it):
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ $VENV/bin/initialize_tutorial_db development.ini
-**On Windows**:
+On Windows
+----------
.. code-block:: text
@@ -319,13 +337,15 @@ Starting the Application
Start the application.
-**On UNIX**:
+On UNIX
+-------
.. code-block:: text
$ $VENV/bin/pserve development.ini --reload
-**On Windows**:
+On Windows
+----------
.. code-block:: text