[doc] Update "settings" pyramid documentation 3.25
authorDenis Laxalde <denis.laxalde@logilab.fr>
Wed, 22 Mar 2017 14:38:10 +0100
branch3.25
changeset 12098 452129511244
parent 12097 78a5c6a64fad
child 12099 5dd20fc21557
[doc] Update "settings" pyramid documentation Document that without "bwcompat" we can use a development.ini file directly and add a dedicated section to list configuration options.
doc/book/pyramid/settings.rst
--- a/doc/book/pyramid/settings.rst	Wed Mar 22 14:37:04 2017 +0100
+++ b/doc/book/pyramid/settings.rst	Wed Mar 22 14:38:10 2017 +0100
@@ -13,12 +13,13 @@
 
 .. _pyramid_settings:
 
-Pyramid Settings
-----------------
+Pyramid Settings file
+---------------------
 
-If a ``pyramid.ini`` file is found in the instance home directory (where the
-``all-in-one.conf`` file is), its ``[main]`` section will be read and used as the
-``settings`` of the pyramid Configurator.
+In *backwards compatibility* mode, Pyramid settings will be looked for in a
+``pyramid.ini`` file in the instance home directory (where the
+``all-in-one.conf`` file is), its ``[main]`` section will be read and used as
+the ``settings`` of the pyramid Configurator.
 
 This configuration file is almost the same as the one read by ``pserve``, which
 allow to easily add any pyramid extension and configure it.
@@ -43,6 +44,14 @@
 
     redis.sessions.host = mywheezy
 
+
+Without *backwards compatibility* a standard ``development.ini`` file can be
+used with any useful CubicWeb-specific settings added.
+
+
+Pyramid CubicWeb configuration entries
+--------------------------------------
+
 The Pyramid CubicWeb specific configuration entries are:
 
 .. confval:: cubicweb.instance (string)