diff options
| author | Chris McDonough <chrism@plope.com> | 2010-11-11 16:22:44 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2010-11-11 16:22:44 -0500 |
| commit | a1365e6f0da69e1b4e3f9cea11222849e5ca810a (patch) | |
| tree | 86cb672f8e7dc158ecda8e4df32d819a2f053bc1 /docs | |
| parent | 5a972bc6a0c608395a495eb12e63020e2295ef6d (diff) | |
| download | pyramid-a1365e6f0da69e1b4e3f9cea11222849e5ca810a.tar.gz pyramid-a1365e6f0da69e1b4e3f9cea11222849e5ca810a.tar.bz2 pyramid-a1365e6f0da69e1b4e3f9cea11222849e5ca810a.zip | |
document the request.settings attribute as well as we can
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 1 | ||||
| -rw-r--r-- | docs/glossary.rst | 7 | ||||
| -rw-r--r-- | docs/latexindex.rst | 1 | ||||
| -rw-r--r-- | docs/narr/startup.rst | 11 |
4 files changed, 20 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst index 217a2e289..f8c532cd6 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -20,6 +20,7 @@ documentation is organized alphabetically by module name. api/interfaces api/location api/paster + api/registry api/renderers api/request api/response diff --git a/docs/glossary.rst b/docs/glossary.rst index 9ba343019..ee7a2784d 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -826,3 +826,10 @@ Glossary :meth:`pyramid.configuration.Configurator.add_view` to make it more convenient to register a collection of views as a single class when using :term:`url dispatch`. See also :ref:`handlers_chapter`. + + Deployment settings + Deployment settings are settings passed to the :term:`Configurator` as a + ``settings`` argument. These are later accessible via a + ``request.registry.settings`` dictionary. Deployment settings can be + used as global application values. + diff --git a/docs/latexindex.rst b/docs/latexindex.rst index f120f1358..4efb193bd 100644 --- a/docs/latexindex.rst +++ b/docs/latexindex.rst @@ -94,6 +94,7 @@ API Reference api/interfaces api/location api/paster + api/registry api/renderers api/request api/response diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 9d9baf92d..c57525f4c 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -138,7 +138,18 @@ press ``return`` after running ``paster serve development.ini``. the application, and the application is running, waiting to receive requests. +.. _deployment_settings: +Deployment Settings +------------------- + +Note that an augmented version of the values passed as ``**settings`` to the +:class:`pyramid.configuration.Configurator` constructor will be available in +:app:`Pyramid` :term:`view callable` code as ``request.registry.settings``. +You can create objects you wish to access later from view code, and put them +into the dictionary you pass to the configurator as ``settings``. They will +then be present in the ``request.registry.settings`` dictionary at +application runtime. |