categorized configurator methods

1 files changed, 68 insertions, 65 deletions

diff --git a/docs/api/config.rst b/docs/api/config.rst
index 87ba94673..b76fed9cb 100644
--- a/docs/api/config.rst
+++ b/docs/api/config.rst
@@ -1,99 +1,102 @@
 .. _configuration_module:
 
+.. role:: methodcategory
+   :class: methodcategory
+
 :mod:`pyramid.config`
 ---------------------
 
 .. automodule:: pyramid.config
 
-  .. autoclass:: Configurator
-
-     .. automethod:: add_route
-
-     .. automethod:: add_view
-
-     .. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED)
-
-     .. automethod:: add_renderer
-
-     .. automethod:: add_subscriber
-
-     .. automethod:: add_response_adapter
-
-     .. automethod:: add_settings
+.. autoclass:: Configurator
 
-     .. automethod:: add_translation_dirs
+  :methodcategory:`Controlling Configuration State`
 
-     .. automethod:: add_tween
+    .. automethod:: commit
+    .. automethod:: begin
+    .. automethod:: end
+    .. automethod:: include
+    .. automethod:: make_wsgi_app()
+    .. automethod:: scan
 
-     .. automethod:: add_traverser
+  :methodcategory:`Adding Routes and Views`
 
-     .. automethod:: add_resource_url_adapter
-
-     .. automethod:: make_wsgi_app()
+    .. 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:: override_asset(to_override, override_with)
+  :methodcategory:`Adding an Event Subscriber`
 
-     .. automethod:: scan
+    .. automethod:: add_subscriber
 
-     .. automethod:: set_locale_negotiator
+  :methodcategory:`Using Security`
 
+     .. 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
-
-     .. automethod:: set_view_mapper
-
-     .. automethod:: set_authentication_policy
-
-     .. automethod:: set_authorization_policy
-
-     .. automethod:: testing_securitypolicy
+   :methodcategory:`Using I18N`
 
-     .. automethod:: testing_resources
-
-     .. automethod:: testing_add_subscriber
+     .. automethod:: add_translation_dirs
+     .. automethod:: set_locale_negotiator
 
-     .. automethod:: testing_add_renderer
+   :methodcategory:`Overriding Assets`
 
-     .. automethod:: set_forbidden_view
+     .. automethod:: override_asset(to_override, override_with)
 
-     .. automethod:: set_notfound_view
+   :methodcategory:`Setting Renderer Globals`
 
      .. automethod:: set_renderer_globals_factory(factory)
 
-     .. automethod:: begin
-
-     .. automethod:: end
-
-     .. automethod:: hook_zca
-
-     .. automethod:: unhook_zca
+   :methodcategory:`Getting and Adding Settings`
 
+     .. automethod:: add_settings
      .. automethod:: get_settings
 
-     .. automethod:: commit
+   :methodcategory:`Hooking Pyramid Behavior`
 
-     .. automethod:: action
+     .. 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
 
-     .. automethod:: include
+   :methodcategory:`Extension Author APIs`
 
+     .. automethod:: action
      .. 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.