summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorAlexandre Bourget <alexandre.bourget@savoirfairelinux.com>2011-03-24 12:07:09 -0400
committerAlexandre Bourget <alexandre.bourget@savoirfairelinux.com>2011-03-24 12:07:09 -0400
commit95e799d074de2e81914d513b4c331df1e738c00e (patch)
treeb3039037533610d8c86d82bb28f139d8a3777013 /docs/api
parent22d3253a26767501827d86b56db3a9b79bef6c4e (diff)
parentb596e1812627c359908759d7a8d83c339f08e385 (diff)
downloadpyramid-95e799d074de2e81914d513b4c331df1e738c00e.tar.gz
pyramid-95e799d074de2e81914d513b4c331df1e738c00e.tar.bz2
pyramid-95e799d074de2e81914d513b4c331df1e738c00e.zip
Merge remote branch 'source/master'
Conflicts: docs/narr/hooks.rst
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/authentication.rst10
-rw-r--r--docs/api/config.rst6
-rw-r--r--docs/api/i18n.rst2
-rw-r--r--docs/api/interfaces.rst4
-rw-r--r--docs/api/registry.rst6
-rw-r--r--docs/api/request.rst21
-rw-r--r--docs/api/router.rst8
-rw-r--r--docs/api/security.rst2
-rw-r--r--docs/api/testing.rst20
-rw-r--r--docs/api/url.rst2
-rw-r--r--docs/api/view.rst1
11 files changed, 48 insertions, 34 deletions
diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst
index 54db77417..a6d4c1e18 100644
--- a/docs/api/authentication.rst
+++ b/docs/api/authentication.rst
@@ -3,6 +3,9 @@
:mod:`pyramid.authentication`
--------------------------------
+Authentication Policies
+~~~~~~~~~~~~~~~~~~~~~~~
+
.. automodule:: pyramid.authentication
.. autoclass:: AuthTktAuthenticationPolicy
@@ -11,3 +14,10 @@
.. autoclass:: RemoteUserAuthenticationPolicy
+Helper Classes
+~~~~~~~~~~~~~~
+
+ .. autoclass:: AuthTktCookieHelper
+
+
+
diff --git a/docs/api/config.rst b/docs/api/config.rst
index 3f37e739c..4b5f1fa21 100644
--- a/docs/api/config.rst
+++ b/docs/api/config.rst
@@ -28,6 +28,8 @@
.. automethod:: include
+ .. automethod:: add_directive
+
.. automethod:: with_package
.. automethod:: maybe_dotted
@@ -48,14 +50,10 @@
.. automethod:: add_translation_dirs
- .. automethod:: add_handler
-
.. automethod:: add_view
.. automethod:: derive_view
- .. automethod:: load_zcml(spec)
-
.. automethod:: make_wsgi_app()
.. automethod:: override_asset(to_override, override_with)
diff --git a/docs/api/i18n.rst b/docs/api/i18n.rst
index 0c2f8b86e..53e8c8a9b 100644
--- a/docs/api/i18n.rst
+++ b/docs/api/i18n.rst
@@ -24,6 +24,8 @@
.. autofunction:: default_locale_negotiator
+ .. autofunction:: make_localizer
+
See :ref:`i18n_chapter` for more information about using
:app:`Pyramid` internationalization and localization services within
an application.
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index b3c14e5f7..3ce926230 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -35,3 +35,7 @@ Other Interfaces
.. autointerface:: ITemplateRenderer
+ .. autointerface:: IViewMapperFactory
+
+ .. autointerface:: IViewMapper
+
diff --git a/docs/api/registry.rst b/docs/api/registry.rst
index 5f61b1122..4d327370a 100644
--- a/docs/api/registry.rst
+++ b/docs/api/registry.rst
@@ -9,6 +9,8 @@
.. attribute:: settings
- The :term:`deployment settings` object. See :ref:`deployment_settings`
- for information.
+ The dictionary-like :term:`deployment settings` object. See
+ :ref:`deployment_settings` for information. This object is often
+ accessed as ``request.registry.settings`` or
+ ``config.registry.settings`` in a typical Pyramid application.
diff --git a/docs/api/request.rst b/docs/api/request.rst
index 13b434a51..d17441c0a 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -113,3 +113,24 @@
request, the value of this attribute will be ``None``. See
:ref:`matched_route`.
+ .. automethod:: add_response_callback
+
+ .. automethod:: add_finished_callback
+
+ .. automethod:: route_url
+
+ .. automethod:: route_path
+
+ .. automethod:: resource_url
+
+ .. automethod:: static_url
+
+ .. attribute:: response_*
+
+ You can set attributes on a :class:`pyramid.request.Request` which will
+ influence the behavor of *rendered* responses (views which use a
+ :term:`renderer` and which don't directly return a response). These
+ attributes begin with ``response_``, such as ``response_headerlist``. If
+ you need to influence response values from a view that uses a renderer
+ (such as the status code, a header, the content type, etc) see,
+ :ref:`response_request_attrs`.
diff --git a/docs/api/router.rst b/docs/api/router.rst
deleted file mode 100644
index e5ffe97ce..000000000
--- a/docs/api/router.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. _router_module:
-
-:mod:`pyramid.router`
----------------------
-
-.. automodule:: pyramid.router
-
-.. autofunction:: pyramid.router.make_app(root_factory, package=None, filename='configure.zcml', settings=None)
diff --git a/docs/api/security.rst b/docs/api/security.rst
index 4acf5fe4d..de249355d 100644
--- a/docs/api/security.rst
+++ b/docs/api/security.rst
@@ -10,6 +10,8 @@ Authentication API Functions
.. autofunction:: authenticated_userid
+.. autofunction:: unauthenticated_userid
+
.. autofunction:: effective_principals
.. autofunction:: forget
diff --git a/docs/api/testing.rst b/docs/api/testing.rst
index fdcdadee8..f388dc263 100644
--- a/docs/api/testing.rst
+++ b/docs/api/testing.rst
@@ -5,26 +5,6 @@
.. automodule:: pyramid.testing
- .. autofunction:: registerDummySecurityPolicy
-
- .. autofunction:: registerResources
-
- .. autofunction:: registerEventListener
-
- .. autofunction:: registerTemplateRenderer
-
- .. autofunction:: registerView
-
- .. autofunction:: registerUtility
-
- .. autofunction:: registerAdapter
-
- .. autofunction:: registerSubscriber
-
- .. autofunction:: registerRoute
-
- .. autofunction:: registerSettings
-
.. autofunction:: setUp
.. autofunction:: tearDown
diff --git a/docs/api/url.rst b/docs/api/url.rst
index 1aa3082b7..01be76283 100644
--- a/docs/api/url.rst
+++ b/docs/api/url.rst
@@ -9,6 +9,8 @@
.. autofunction:: route_url
+ .. autofunction:: current_route_url
+
.. autofunction:: route_path
.. autofunction:: static_url
diff --git a/docs/api/view.rst b/docs/api/view.rst
index 0057cca4a..4dddea25f 100644
--- a/docs/api/view.rst
+++ b/docs/api/view.rst
@@ -18,6 +18,7 @@
.. autoclass:: static
:members:
+ :inherited-members:
.. autofunction:: append_slash_notfound_view(context, request)