categorized configurator methods

Chris McDonough

2012-02-18 66b20a9d467582064b91295dfd364118cc68a568

categorized configurator methods

 docs/api/config.rst

@@ -1,99 +1,102 @@
.. _configuration_module:

.. role:: methodcategory
   :class: methodcategory

:mod:`pyramid.config`
---------------------

.. automodule:: pyramid.config

  .. autoclass:: Configurator
.. autoclass:: Configurator

     .. automethod:: add_route
  :methodcategory:`Controlling Configuration State`

     .. automethod:: add_view
    .. automethod:: commit
    .. automethod:: begin
    .. automethod:: end
    .. automethod:: include
    .. automethod:: make_wsgi_app()
    .. automethod:: scan

     .. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED)
  :methodcategory:`Adding Routes and Views`

     .. automethod:: add_renderer
    .. automethod:: add_route
    .. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED)
    .. automethod:: add_view
    .. automethod:: set_forbidden_view
    .. automethod:: set_notfound_view

     .. automethod:: add_subscriber
  :methodcategory:`Adding an Event Subscriber`

     .. automethod:: add_response_adapter
    .. automethod:: add_subscriber

     .. automethod:: add_settings
  :methodcategory:`Using Security`

     .. automethod:: add_translation_dirs

     .. automethod:: add_tween

     .. automethod:: add_traverser

     .. automethod:: add_resource_url_adapter

     .. automethod:: make_wsgi_app()

     .. automethod:: override_asset(to_override, override_with)

     .. automethod:: scan

     .. automethod:: set_locale_negotiator

     .. automethod:: set_authentication_policy
     .. automethod:: set_authorization_policy
     .. automethod:: set_default_permission

     .. automethod:: set_session_factory

     .. automethod:: set_request_factory
   :methodcategory:`Setting Request Properties`

     .. automethod:: set_request_property

     .. automethod:: set_root_factory
   :methodcategory:`Using I18N`

     .. automethod:: set_view_mapper
     .. automethod:: add_translation_dirs
     .. automethod:: set_locale_negotiator

     .. automethod:: set_authentication_policy
   :methodcategory:`Overriding Assets`

     .. automethod:: set_authorization_policy
     .. automethod:: override_asset(to_override, override_with)

     .. automethod:: testing_securitypolicy

     .. automethod:: testing_resources

     .. automethod:: testing_add_subscriber

     .. automethod:: testing_add_renderer

     .. automethod:: set_forbidden_view

     .. automethod:: set_notfound_view
   :methodcategory:`Setting Renderer Globals`

     .. automethod:: set_renderer_globals_factory(factory)

     .. automethod:: begin
   :methodcategory:`Getting and Adding Settings`

     .. automethod:: end

     .. automethod:: hook_zca

     .. automethod:: unhook_zca

     .. automethod:: add_settings
     .. automethod:: get_settings

     .. automethod:: commit
   :methodcategory:`Hooking Pyramid Behavior`

     .. automethod:: add_renderer
     .. automethod:: add_resource_url_adapter
     .. automethod:: add_response_adapter
     .. automethod:: add_traverser
     .. automethod:: add_tween
     .. automethod:: set_request_factory
     .. automethod:: set_root_factory
     .. automethod:: set_session_factory
     .. automethod:: set_view_mapper

   :methodcategory:`Extension Author APIs`

     .. automethod:: action

     .. automethod:: include

     .. automethod:: add_directive

     .. automethod:: with_package

     .. automethod:: maybe_dotted
   :methodcategory:`Utility Methods`

     .. automethod:: absolute_asset_spec

     .. automethod:: derive_view
     .. automethod:: maybe_dotted
     .. automethod:: setup_registry

     .. automethod:: derive_view
   :methodcategory:`ZCA-Related APIs`

     .. automethod:: hook_zca
     .. automethod:: unhook_zca

   :methodcategory:`Testing Helper APIs`

     .. automethod:: testing_add_renderer
     .. automethod:: testing_add_subscriber
     .. automethod:: testing_resources
     .. automethod:: testing_securitypolicy

   :methodcategory:`Attributes`

     .. attribute:: introspectable

@@ -122,15 +125,15 @@
        The :term:`application registry` which holds the configuration
        associated with this configurator.

  .. attribute:: global_registries
.. attribute:: global_registries

     The set of registries that have been created for :app:`Pyramid`
     applications, one per each call to
     :meth:`pyramid.config.Configurator.make_wsgi_app` in the current
     process. The object itself supports iteration and has a ``last``
     property containing the last registry loaded.
   The set of registries that have been created for :app:`Pyramid`
   applications, one per each call to
   :meth:`pyramid.config.Configurator.make_wsgi_app` in the current
   process. The object itself supports iteration and has a ``last`` property
   containing the last registry loaded.

     The registries contained in this object are stored as weakrefs,
     thus they will only exist for the lifetime of the actual
     applications for which they are being used.
   The registries contained in this object are stored as weakrefs, thus they
   will only exist for the lifetime of the actual applications for which they
   are being used.