summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Bangert <ben@groovie.org>2010-10-29 16:03:20 -0700
committerBen Bangert <ben@groovie.org>2010-10-29 16:03:20 -0700
commit8b0d7ce11cb836b9073010d524cb7f636f1649ec (patch)
treee8f0309546ebb8c40ee83a5416f60e4f12ccfb65 /docs
parent17e70c8db9140c0b4062f46ef5eb4527d678b793 (diff)
parent71ff1038f9ae7578e303ca9f657d34e4ee09305a (diff)
downloadpyramid-8b0d7ce11cb836b9073010d524cb7f636f1649ec.tar.gz
pyramid-8b0d7ce11cb836b9073010d524cb7f636f1649ec.tar.bz2
pyramid-8b0d7ce11cb836b9073010d524cb7f636f1649ec.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs')
-rw-r--r--docs/api/session.rst5
-rw-r--r--docs/conf.py4
-rw-r--r--docs/glossary.rst1
-rw-r--r--docs/narr/project.rst40
-rw-r--r--docs/narr/views.rst2
-rw-r--r--docs/tutorials/catalog/index.rst6
-rw-r--r--docs/tutorials/zeo/index.rst4
7 files changed, 33 insertions, 29 deletions
diff --git a/docs/api/session.rst b/docs/api/session.rst
index daed9fc33..12b727183 100644
--- a/docs/api/session.rst
+++ b/docs/api/session.rst
@@ -7,3 +7,8 @@
.. autofunction:: InsecureCookieSessionFactoryConfig
+ .. autofunction:: signed_serialize
+
+ .. autofunction:: signed_deserialize
+
+
diff --git a/docs/conf.py b/docs/conf.py
index eb236826b..59c0e0b0e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -160,7 +160,7 @@ html_last_updated_fmt = '%b %d, %Y'
#html_file_suffix = ''
# Output file base name for HTML help builder.
-htmlhelp_basename = 'repozebfg'
+htmlhelp_basename = 'pyramid'
# Options for LaTeX output
# ------------------------
@@ -174,7 +174,7 @@ latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [
- ('latexindex', 'repozebfg.tex',
+ ('latexindex', 'pyramid.tex',
'The Pyramid Web Application Development Framework',
'Chris McDonough', 'manual'),
]
diff --git a/docs/glossary.rst b/docs/glossary.rst
index 9259fed0a..7320f5b4c 100644
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -572,7 +572,6 @@ Glossary
of code in a package.
configuration decoration
-
Metadata implying one or more :term:`configuration declaration`
invocations. Often set by configuration Python :term:`decorator`
attributes, such as :class:`pyramid.view.view_config`, aka
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index f88496fcc..4e140709c 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -117,7 +117,7 @@ project we name ``MyProject``:
$ bin/paster create -t pyramid_starter
Selected and implied templates:
- pyramid#bfg pyramid starter project
+ pyramid#pyramid_starter pyramid starter project
Enter project name: MyProject
Variables:
@@ -223,18 +223,18 @@ the ``pyramid_starter`` template, a single sample test exists.
.. index::
single: interactive shell
single: IPython
- single: paster bfgshell
+ single: paster pshell
The Interactive Shell
---------------------
Once you've installed your program for development using ``setup.py
develop``, you can use an interactive Python shell to examine your
-:mod:`pyramid` application :term:`model` and :term:`view` objects
-from a Python prompt. To do so, use the ``paster`` shell command with
-the ``bfgshell`` argument:
+:mod:`pyramid` application :term:`model` and :term:`view` objects from
+a Python prompt. To do so, use the ``paster`` shell command with the
+``pshell`` argument:
-The first argument to ``bfgshell`` is the path to your application's
+The first argument to ``pshell`` is the path to your application's
``.ini`` file. The second is the section name inside the ``.ini``
file which points to your *application* as opposed to any other
section within the ``.ini`` file. For example, if your application
@@ -256,37 +256,37 @@ the name ``main`` as a section name:
.. code-block:: text
- [chrism@vitaminf bfgshellenv]$ ../bin/paster --plugin=pyramid bfgshell \
- MyProject.ini main
+ [chrism@vitaminf shellenv]$ ../bin/paster --plugin=pyramid \
+ pshell MyProject.ini main
Python 2.4.5 (#1, Aug 29 2008, 12:27:37)
[GCC 4.0.1 (Apple Inc. build 5465)] on darwin
- Type "help" for more information. "root" is the BFG app root object.
+ Type "help" for more information. "root" is the Pyramid app root object.
>>> root
<foo.models.MyModel object at 0x445270>
.. note:: You *might* get away without passing
- ``--plugin=pyramid`` to the bfgshell command.
+ ``--plugin=pyramid`` to the ``pshell`` command.
If you have `IPython <http://en.wikipedia.org/wiki/IPython>`_
installed in the interpreter you use to invoke the ``paster`` command,
-the ``bfgshell`` command will use an IPython interactive shell instead
+the ``pshell`` command will use an IPython interactive shell instead
of a standard Python interpreter shell. If you don't want this to
happen, even if you have IPython installed, you can pass the
-``--disable-ipython`` flag to the ``bfgshell`` command to use a
-standard Python interpreter shell unconditionally.
+``--disable-ipython`` flag to the ``pshell`` command to use a standard
+Python interpreter shell unconditionally.
.. code-block:: text
- [chrism@vitaminf bfgshellenv]$ ../bin/paster --plugin=pyramid bfgshell \
+ [chrism@vitaminf shellenv]$ ../bin/paster --plugin=pyramid pshell \
--disable-ipython MyProject.ini main
You should always use a section name argument that refers to the
actual ``app`` section within the Paste configuration file that points
-at your :mod:`pyramid` application *without any middleware
-wrapping*. In particular, a section name is inappropriate as the
-second argument to "bfgshell" if the configuration section it names is
-a ``pipeline`` rather than an ``app``. For example, if you have the
-following ``.ini`` file content:
+at your :mod:`pyramid` application *without any middleware wrapping*.
+In particular, a section name is inappropriate as the second argument
+to ``pshell`` if the configuration section it names is a ``pipeline``
+rather than an ``app``. For example, if you have the following
+``.ini`` file content:
.. code-block:: ini
:linenos:
@@ -307,7 +307,7 @@ The command you use to invoke the interactive shell should be:
.. code-block:: text
- [chrism@vitaminf bfgshellenv]$ ../bin/paster --plugin=pyramid bfgshell \
+ [chrism@vitaminf shellenv]$ ../bin/paster --plugin=pyramid pshell \
MyProject.ini myapp
If you use ``main`` as the section name argument instead of ``myapp``
diff --git a/docs/narr/views.rst b/docs/narr/views.rst
index 39115a493..37fb6562b 100644
--- a/docs/narr/views.rst
+++ b/docs/narr/views.rst
@@ -1502,7 +1502,7 @@ See :ref:`view_directive` for complete ZCML directive documentation.
.. _mapping_views_using_a_decorator_section:
View Configuration Using the ``@view_config`` Decorator
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For better locality of reference, you may use the
:class:`pyramid.view.view_config` decorator to associate your view
diff --git a/docs/tutorials/catalog/index.rst b/docs/tutorials/catalog/index.rst
index 424286bd9..e4f6fe70e 100644
--- a/docs/tutorials/catalog/index.rst
+++ b/docs/tutorials/catalog/index.rst
@@ -78,12 +78,12 @@ want the application to be based on :term:`traversal`.
return root['site']
#. We'll demonstrate how you might interact with a catalog from code
- by manipulating the database directly using the ``bfgshell``
+ by manipulating the database directly using the ``pshell``
command in a terminal window:
.. code-block:: text
- [chrism@snowpro sess]$ ../bin/paster --plugin=pyramid bfgshell \
+ [chrism@snowpro sess]$ ../bin/paster --plugin=pyramid pshell \
myapp.ini myapp
Python 2.5.4 (r254:67916, Sep 4 2009, 02:12:16)
[GCC 4.2.1 (Apple Inc. build 5646)] on darwin
@@ -103,7 +103,7 @@ As you need them, add other indexes required by your application to
the catalog by modifying the ``update_indexes`` method of the ``Site``
object. Whenever an index is added or removed, invoke the
``update_indexes`` method of the site (the root object) from a script
-or from within a ``bfgshell`` session to update the set of indexes
+or from within a ``pshell`` session to update the set of indexes
used by your application.
In :term:`view` code, you should be able to get a hold of the root
diff --git a/docs/tutorials/zeo/index.rst b/docs/tutorials/zeo/index.rst
index 1f6d1dac3..2e9d4aa2f 100644
--- a/docs/tutorials/zeo/index.rst
+++ b/docs/tutorials/zeo/index.rst
@@ -218,13 +218,13 @@ Running
about the application has changed.
#. You can manipulate the database directly (even when the
- application's HTTP server is running) by using the ``bfgshell``
+ application's HTTP server is running) by using the ``pshell``
command in a third terminal window:
.. code-block:: text
:linenos:
- [chrism@snowpro sess]$ ../bin/paster --plugin=pyramid bfgshell \
+ [chrism@snowpro sess]$ ../bin/paster --plugin=pyramid pshell \
myapp.ini myapp
Python 2.5.4 (r254:67916, Sep 4 2009, 02:12:16)
[GCC 4.2.1 (Apple Inc. build 5646)] on darwin