pyramid_cubicweb/defaults.py
changeset 11537 caf268942436
parent 11533 4ced3782b90f
--- a/pyramid_cubicweb/defaults.py	Mon Jan 05 12:02:01 2015 +0100
+++ b/pyramid_cubicweb/defaults.py	Sat Jan 03 22:06:03 2015 +0100
@@ -1,4 +1,24 @@
+""" Defaults for a classical CubicWeb instance. """
+
+
 def includeme(config):
+    """ Enable the defaults that make the application behave like a classical
+    CubicWeb instance.
+
+    The following modules get included:
+
+    -   :func:`pyramid_cubicweb.session <pyramid_cubicweb.session.includeme>`
+    -   :func:`pyramid_cubicweb.auth <pyramid_cubicweb.auth.includeme>`
+    -   :func:`pyramid_cubicweb.login <pyramid_cubicweb.login.includeme>`
+
+    It is automatically included by the configuration system, unless the
+    following entry is added to the :ref:`pyramid_settings`:
+
+    .. code-block:: ini
+
+        cubicweb.defaults = no
+
+    """
     config.include('pyramid_cubicweb.session')
     config.include('pyramid_cubicweb.auth')
     config.include('pyramid_cubicweb.login')