convert API docs to Pyramid

24 files changed, 62 insertions, 65 deletions

diff --git a/docs/api.rst b/docs/api.rst
index 050e8be13..bf7933a65 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -2,7 +2,7 @@ API Documentation
 =================
 
 Comprehensive reference material for every public API exposed by
-:mod:`repoze.bfg` is available within this chapter.  The API
+:mod:`pyramid` is available within this chapter.  The API
 documentation is organized alphabetically by module name.
 
 .. toctree::
diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst
index c6d169b50..54db77417 100644
--- a/docs/api/authentication.rst
+++ b/docs/api/authentication.rst
@@ -1,9 +1,9 @@
 .. _authentication_module:
 
-:mod:`repoze.bfg.authentication`
+:mod:`pyramid.authentication`
 --------------------------------
 
-.. automodule:: repoze.bfg.authentication
+.. automodule:: pyramid.authentication
 
   .. autoclass:: AuthTktAuthenticationPolicy
 
diff --git a/docs/api/authorization.rst b/docs/api/authorization.rst
index 065a1893b..5f5435b94 100644
--- a/docs/api/authorization.rst
+++ b/docs/api/authorization.rst
@@ -1,9 +1,9 @@
 .. _authorization_module:
 
-:mod:`repoze.bfg.authorization`
+:mod:`pyramid.authorization`
 -------------------------------
 
-.. automodule:: repoze.bfg.authorization
+.. automodule:: pyramid.authorization
 
   .. autoclass:: ACLAuthorizationPolicy
 
diff --git a/docs/api/chameleon_text.rst b/docs/api/chameleon_text.rst
index 51e5fc58c..494f5b464 100644
--- a/docs/api/chameleon_text.rst
+++ b/docs/api/chameleon_text.rst
@@ -1,9 +1,9 @@
 .. _chameleon_text_module:
 
-:mod:`repoze.bfg.chameleon_text`
+:mod:`pyramid.chameleon_text`
 ----------------------------------
 
-.. automodule:: repoze.bfg.chameleon_text
+.. automodule:: pyramid.chameleon_text
 
   .. autofunction:: get_template
 
@@ -14,18 +14,18 @@
 These APIs will will work against template files which contain simple
 ``${Genshi}`` - style replacement markers.
 
-The API of :mod:`repoze.bfg.chameleon_text` is identical to that of
-:mod:`repoze.bfg.chameleon_zpt`; only its import location is
+The API of :mod:`pyramid.chameleon_text` is identical to that of
+:mod:`pyramid.chameleon_zpt`; only its import location is
 different.  If you need to import an API functions from this module as
-well as the :mod:`repoze.bfg.chameleon_zpt` module within the same
+well as the :mod:`pyramid.chameleon_zpt` module within the same
 view file, use the ``as`` feature of the Python import statement,
 e.g.:
 
 .. code-block:: python
    :linenos:
 
-   from repoze.bfg.chameleon_zpt import render_template as zpt_render
-   from repoze.bfg.chameleon_text import render_template as text_render
+   from pyramid.chameleon_zpt import render_template as zpt_render
+   from pyramid.chameleon_text import render_template as text_render
 
 
 
diff --git a/docs/api/chameleon_zpt.rst b/docs/api/chameleon_zpt.rst
index 0971daca3..df9a36a56 100644
--- a/docs/api/chameleon_zpt.rst
+++ b/docs/api/chameleon_zpt.rst
@@ -1,9 +1,9 @@
 .. _chameleon_zpt_module:
 
-:mod:`repoze.bfg.chameleon_zpt`
+:mod:`pyramid.chameleon_zpt`
 -------------------------------
 
-.. automodule:: repoze.bfg.chameleon_zpt
+.. automodule:: pyramid.chameleon_zpt
 
   .. autofunction:: get_template
 
@@ -14,15 +14,15 @@
 These APIs will work against files which supply template text which
 matches the :term:`ZPT` specification.
 
-The API of :mod:`repoze.bfg.chameleon_zpt` is identical to that of
-:mod:`repoze.bfg.chameleon_text`; only its import location is
+The API of :mod:`pyramid.chameleon_zpt` is identical to that of
+:mod:`pyramid.chameleon_text`; only its import location is
 different.  If you need to import an API functions from this module as
-well as the :mod:`repoze.bfg.chameleon_text` module within the same
+well as the :mod:`pyramid.chameleon_text` module within the same
 view file, use the ``as`` feature of the Python import statement,
 e.g.:
 
 .. code-block:: python
    :linenos:
 
-   from repoze.bfg.chameleon_zpt import render_template as zpt_render
-   from repoze.bfg.chameleon_text import render_template as text_render
+   from pyramid.chameleon_zpt import render_template as zpt_render
+   from pyramid.chameleon_text import render_template as text_render
diff --git a/docs/api/configuration.rst b/docs/api/configuration.rst
index 1fb232275..c0b52ed3f 100644
--- a/docs/api/configuration.rst
+++ b/docs/api/configuration.rst
@@ -1,9 +1,9 @@
 .. _configuration_module:
 
-:mod:`repoze.bfg.configuration`
+:mod:`pyramid.configuration`
 -------------------------------
 
-.. automodule:: repoze.bfg.configuration
+.. automodule:: pyramid.configuration
 
   .. autoclass:: Configurator(registry=None, package=None, settings=None, root_factory=None, authentication_policy=None, authorization_policy=None, renderers=DEFAULT_RENDERERS, debug_logger=None, locale_negotiator=None, request_factory=None, renderer_globals_factory=None, default_permission=None)
 
diff --git a/docs/api/events.rst b/docs/api/events.rst
index 940c23aa1..8371ba61d 100644
--- a/docs/api/events.rst
+++ b/docs/api/events.rst
@@ -1,9 +1,9 @@
 .. _events_module:
 
-:mod:`repoze.bfg.events`
+:mod:`pyramid.events`
 --------------------------
 
-.. automodule:: repoze.bfg.events
+.. automodule:: pyramid.events
 
 Functions
 ~~~~~~~~~
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst
index 94c75cc5c..1dfbf46fd 100644
--- a/docs/api/exceptions.rst
+++ b/docs/api/exceptions.rst
@@ -1,9 +1,9 @@
 .. _exceptions_module:
 
-:mod:`repoze.bfg.exceptions`
+:mod:`pyramid.exceptions`
 ----------------------------
 
-.. automodule:: repoze.bfg.exceptions
+.. automodule:: pyramid.exceptions
 
   .. autoclass:: Forbidden
 
diff --git a/docs/api/i18n.rst b/docs/api/i18n.rst
index 6562bb13b..9b919c3ee 100644
--- a/docs/api/i18n.rst
+++ b/docs/api/i18n.rst
@@ -1,9 +1,9 @@
 .. _i18n_module:
 
-:mod:`repoze.bfg.i18n`
+:mod:`pyramid.i18n`
 ----------------------
 
-.. automodule:: repoze.bfg.i18n
+.. automodule:: pyramid.i18n
 
   .. autoclass:: TranslationString
  
@@ -25,7 +25,7 @@
   .. autofunction:: default_locale_negotiator
 
 See :ref:`i18n_chapter` for more information about using
-:mod:`repoze.bfg` internationalization and localization services
-within an application.
+:mod:`pyramid` internationalization and localization services within
+an application.
 
 
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index be2de2c7f..7193fd11b 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -1,9 +1,9 @@
 .. _interfaces_module:
 
-:mod:`repoze.bfg.interfaces`
+:mod:`pyramid.interfaces`
 ----------------------------
 
-.. automodule:: repoze.bfg.interfaces
+.. automodule:: pyramid.interfaces
 
 Event-Related Interfaces
 ++++++++++++++++++++++++
diff --git a/docs/api/location.rst b/docs/api/location.rst
index b2625f49c..30f6079f2 100644
--- a/docs/api/location.rst
+++ b/docs/api/location.rst
@@ -1,9 +1,9 @@
 .. _location_module:
 
-:mod:`repoze.bfg.location`
+:mod:`pyramid.location`
 --------------------------
 
-.. automodule:: repoze.bfg.location
+.. automodule:: pyramid.location
 
   .. autofunction:: lineage
 
diff --git a/docs/api/paster.rst b/docs/api/paster.rst
index 66049ac64..9ecfa3d9c 100644
--- a/docs/api/paster.rst
+++ b/docs/api/paster.rst
@@ -1,9 +1,9 @@
 .. _paster_module:
 
-:mod:`repoze.bfg.paster`
+:mod:`pyramid.paster`
 ---------------------------
 
-.. module:: repoze.bfg.paster
+.. module:: pyramid.paster
 
 .. function:: get_app(config_file, name)
 
diff --git a/docs/api/renderers.rst b/docs/api/renderers.rst
index 775b8d8d8..459639a46 100644
--- a/docs/api/renderers.rst
+++ b/docs/api/renderers.rst
@@ -1,9 +1,9 @@
 .. _renderers_module:
 
-:mod:`repoze.bfg.renderers`
+:mod:`pyramid.renderers`
 ---------------------------
 
-.. module:: repoze.bfg.renderers
+.. module:: pyramid.renderers
 
 .. autofunction:: get_renderer
 
diff --git a/docs/api/request.rst b/docs/api/request.rst
index c37565ccd..e53028b0f 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -1,9 +1,9 @@
 .. _request_module:
 
-:mod:`repoze.bfg.request`
+:mod:`pyramid.request`
 ---------------------------
 
-.. module:: repoze.bfg.request
+.. module:: pyramid.request
 
 .. autoclass:: Request
    :members:
@@ -77,7 +77,7 @@
 
      If an exception was raised by a :term:`root factory` or a
      :term:`view callable`, or at various other points where
-     :mod:`repoze.bfg` executes user-defined code during the
+     :mod:`pyramid` executes user-defined code during the
      processing of a request, the exception object which was caught
      will be available as the ``exception`` attribute of the request
      within a :term:`exception view`, a :term:`response callback` or a
@@ -85,6 +85,3 @@
      of ``request.exception`` will be ``None`` within response and
      finished callbacks.
 
-     .. note:: The exception attribute is new in :mod:`repoze.bfg`
-        1.3.
-
diff --git a/docs/api/router.rst b/docs/api/router.rst
index 2bccb9e18..a4a4c176a 100644
--- a/docs/api/router.rst
+++ b/docs/api/router.rst
@@ -1,8 +1,8 @@
 .. _router_module:
 
-:mod:`repoze.bfg.router`
+:mod:`pyramid.router`
 ------------------------
 
-.. automodule:: repoze.bfg.router
+.. automodule:: pyramid.router
 
-.. autofunction:: repoze.bfg.router.make_app(root_factory, package=None, filename='configure.zcml', settings=None)
+.. autofunction:: pyramid.router.make_app(root_factory, package=None, filename='configure.zcml', settings=None)
diff --git a/docs/api/scripting.rst b/docs/api/scripting.rst
index afb86d9bb..9d5bc2e58 100644
--- a/docs/api/scripting.rst
+++ b/docs/api/scripting.rst
@@ -1,9 +1,9 @@
 .. _scripting_module:
 
-:mod:`repoze.bfg.scripting`
+:mod:`pyramid.scripting`
 ---------------------------
 
-.. automodule:: repoze.bfg.scripting
+.. automodule:: pyramid.scripting
 
   .. autofunction:: get_root
 
diff --git a/docs/api/security.rst b/docs/api/security.rst
index f29d66464..4acf5fe4d 100644
--- a/docs/api/security.rst
+++ b/docs/api/security.rst
@@ -1,9 +1,9 @@
 .. _security_module:
 
-:mod:`repoze.bfg.security`
+:mod:`pyramid.security`
 ==========================
 
-.. automodule:: repoze.bfg.security
+.. automodule:: pyramid.security
 
 Authentication API Functions
 ----------------------------
diff --git a/docs/api/settings.rst b/docs/api/settings.rst
index f314779be..acd674f66 100644
--- a/docs/api/settings.rst
+++ b/docs/api/settings.rst
@@ -1,9 +1,9 @@
 .. _settings_module:
 
-:mod:`repoze.bfg.settings`
+:mod:`pyramid.settings`
 --------------------------
 
-.. automodule:: repoze.bfg.settings
+.. automodule:: pyramid.settings
 
   .. autofunction:: get_settings
 
diff --git a/docs/api/testing.rst b/docs/api/testing.rst
index d95f5ba63..2fdea6cd7 100644
--- a/docs/api/testing.rst
+++ b/docs/api/testing.rst
@@ -1,9 +1,9 @@
 .. _testing_module:
 
-:mod:`repoze.bfg.testing`
+:mod:`pyramid.testing`
 ==========================
 
-.. automodule:: repoze.bfg.testing
+.. automodule:: pyramid.testing
 
   .. autofunction:: registerDummySecurityPolicy
 
diff --git a/docs/api/threadlocal.rst b/docs/api/threadlocal.rst
index a40e70e3a..680444dee 100644
--- a/docs/api/threadlocal.rst
+++ b/docs/api/threadlocal.rst
@@ -1,9 +1,9 @@
 .. _threadlocal_module:
 
-:mod:`repoze.bfg.threadlocal`
+:mod:`pyramid.threadlocal`
 -------------------------------
 
-.. automodule:: repoze.bfg.threadlocal
+.. automodule:: pyramid.threadlocal
 
    .. autofunction:: get_current_request()
 
diff --git a/docs/api/traversal.rst b/docs/api/traversal.rst
index 4b52a906d..b89691847 100644
--- a/docs/api/traversal.rst
+++ b/docs/api/traversal.rst
@@ -1,9 +1,9 @@
 .. _traversal_module:
 
-:mod:`repoze.bfg.traversal`
+:mod:`pyramid.traversal`
 ---------------------------
 
-.. automodule:: repoze.bfg.traversal
+.. automodule:: pyramid.traversal
 
   .. autofunction:: find_interface
 
diff --git a/docs/api/url.rst b/docs/api/url.rst
index b060f4a59..71987498a 100644
--- a/docs/api/url.rst
+++ b/docs/api/url.rst
@@ -1,11 +1,11 @@
 .. _url_module:
 
-:mod:`repoze.bfg.url`
+:mod:`pyramid.url`
 ---------------------
 
-.. automodule:: repoze.bfg.url
+.. automodule:: pyramid.url
 
-  .. autofunction:: repoze.bfg.url.model_url(context, request, *elements, query=None, anchor=None)
+  .. autofunction:: pyramid.url.model_url(context, request, *elements, query=None, anchor=None)
 
   .. autofunction:: route_url
 
diff --git a/docs/api/view.rst b/docs/api/view.rst
index f15f1bc0d..5e884656c 100644
--- a/docs/api/view.rst
+++ b/docs/api/view.rst
@@ -1,9 +1,9 @@
 .. _view_module:
 
-:mod:`repoze.bfg.view`
+:mod:`pyramid.view`
 ----------------------
 
-.. automodule:: repoze.bfg.view
+.. automodule:: pyramid.view
 
   .. autofunction:: render_view_to_response
 
diff --git a/docs/api/wsgi.rst b/docs/api/wsgi.rst
index 6b5423c55..3fe742066 100644
--- a/docs/api/wsgi.rst
+++ b/docs/api/wsgi.rst
@@ -1,9 +1,9 @@
 .. _wsgi_module:
 
-:mod:`repoze.bfg.wsgi`
+:mod:`pyramid.wsgi`
 --------------------------
 
-.. automodule:: repoze.bfg.wsgi
+.. automodule:: pyramid.wsgi
 
   .. autofunction:: wsgiapp