- Put pyramid.includes targets within ini files in scaffolds on s…

…eparate lines in order to be able to tell people to comment out only the ``pyramid_debugtoolbar`` line when they want to disable the toolbar.
Pylons · Feb 19, 2012 · d21ba4b · d21ba4b
1 parent 7f89e2d
commit d21ba4b
Show file tree

Hide file tree

Showing 29 changed files with 121 additions and 59 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -93,6 +93,13 @@ Documentation
 - Don't create a ``session`` instance in SQLA Wiki tutorial, use raw
   ``DBSession`` instead (this is more common in real SQLA apps).
 
+Scaffolding
+-----------
+
+- Put ``pyramid.includes`` targets within ini files in scaffolds on separate
+  lines in order to be able to tell people to comment out only the
+  ``pyramid_debugtoolbar`` line when they want to disable the toolbar.
+
 Dependencies
 ------------
 

diff --git a/TODO.txt b/TODO.txt
@@ -16,10 +16,6 @@ Nice-to-Have
 - Fix renderers chapter to better document system values passed to template
   renderers.
 
-- Put includes in development.ini within scaffolding and tutorials on
-  separate lines and fix project.rst to tell people to comment out only the
-  debugtoolbar include when they want to disable.
-
 - Modify view mapper narrative docs to not use pyramid_handlers.
 
 - Modify the urldispatch chapter examples to assume a scan rather than

diff --git a/docs/narr/MyProject/development.ini b/docs/narr/MyProject/development.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
+pyramid.includes =
+    pyramid_debugtoolbar
 
 [server:main]
 use = egg:waitress#main

diff --git a/docs/narr/project.rst b/docs/narr/project.rst
@@ -348,27 +348,48 @@ when you use the ``production.ini`` file instead of the ``development.ini``
 ini file to run the application.
 
 You can also turn the debug toolbar off by editing ``development.ini`` and
-commenting out the line ``pyramid.includes = pyramid_debugtoolbar``.  For
-example, instead of:
+commenting out a line.  For example, instead of:
 
 .. code-block:: ini
    :linenos:
 
    [app:main]
    ...
-   pyramid.includes = pyramid_debugtoolbar
+   pyramid.includes =
+       pyramid_debugtoolbar
 
-Put a hash mark in front of the ``pyramid.includes`` line:
+Put a hash mark at the beginning of the ``pyramid_debugtoolbar`` line:
 
 .. code-block:: ini
    :linenos:
 
    [app:main]
    ...
-   #pyramid.includes = pyramid_debugtoolbar
+   pyramid.includes =
+   #    pyramid_debugtoolbar
 
 Then restart the application to see that the toolbar has been turned off.
 
+Note that if you comment out the ``pryamid_debugtoolbar`` line, the ``#``
+*must* be in the first column.  If you put the hash mark anywhere except the
+first column instead, for example like this:
+
+.. code-block:: ini
+   :linenos:
+
+   [app:main]
+   ...
+   pyramid.includes =
+       #pyramid_debugtoolbar
+
+When you attempt to restart the application with a section like the abvoe
+you'll receive an error that ends something like this, and the application
+will not start:
+
+.. code-block:: text
+
+   ImportError: No module named #pyramid_debugtoolbar
+
 .. index::
    single: project structure
 

diff --git a/docs/tutorials/wiki/src/authorization/development.ini b/docs/tutorials/wiki/src/authorization/development.ini
@@ -6,9 +6,11 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_zodbconn
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_zodbconn
+    pyramid_tm
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/authorization/production.ini b/docs/tutorials/wiki/src/authorization/production.ini
@@ -6,8 +6,10 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
-                   pyramid_zodbconn
+pyramid.includes =
+    pyramid_tm
+    pyramid_zodbconn
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/basiclayout/development.ini b/docs/tutorials/wiki/src/basiclayout/development.ini
@@ -6,9 +6,11 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_zodbconn
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_zodbconn
+    pyramid_tm
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/basiclayout/production.ini b/docs/tutorials/wiki/src/basiclayout/production.ini
@@ -6,8 +6,10 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
-                   pyramid_zodbconn
+pyramid.includes =
+    pyramid_tm
+    pyramid_zodbconn
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/models/development.ini b/docs/tutorials/wiki/src/models/development.ini
@@ -6,9 +6,11 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_zodbconn
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_zodbconn
+    pyramid_tm
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/models/production.ini b/docs/tutorials/wiki/src/models/production.ini
@@ -6,8 +6,10 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
-                   pyramid_zodbconn
+pyramid.includes =
+    pyramid_tm
+    pyramid_zodbconn
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/tests/development.ini b/docs/tutorials/wiki/src/tests/development.ini
@@ -6,9 +6,11 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_zodbconn
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_zodbconn
+    pyramid_tm
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/tests/production.ini b/docs/tutorials/wiki/src/tests/production.ini
@@ -6,8 +6,10 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
-                   pyramid_zodbconn
+pyramid.includes =
+    pyramid_tm
+    pyramid_zodbconn
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/views/development.ini b/docs/tutorials/wiki/src/views/development.ini
@@ -6,9 +6,11 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_zodbconn
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_zodbconn
+    pyramid_tm
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki/src/views/production.ini b/docs/tutorials/wiki/src/views/production.ini
@@ -6,8 +6,10 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
-                   pyramid_zodbconn
+pyramid.includes =
+    pyramid_tm
+    pyramid_zodbconn
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/docs/tutorials/wiki2/src/authorization/development.ini b/docs/tutorials/wiki2/src/authorization/development.ini
@@ -7,8 +7,9 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/authorization/production.ini b/docs/tutorials/wiki2/src/authorization/production.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
+pyramid.includes =
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/basiclayout/development.ini b/docs/tutorials/wiki2/src/basiclayout/development.ini
@@ -7,8 +7,9 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/basiclayout/production.ini b/docs/tutorials/wiki2/src/basiclayout/production.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
+pyramid.includes =
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/models/development.ini b/docs/tutorials/wiki2/src/models/development.ini
@@ -7,8 +7,9 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/models/production.ini b/docs/tutorials/wiki2/src/models/production.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
+pyramid.includes =
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/tests/development.ini b/docs/tutorials/wiki2/src/tests/development.ini
@@ -7,8 +7,9 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/tests/production.ini b/docs/tutorials/wiki2/src/tests/production.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
+pyramid.includes =
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/views/development.ini b/docs/tutorials/wiki2/src/views/development.ini
@@ -7,8 +7,9 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/docs/tutorials/wiki2/src/views/production.ini b/docs/tutorials/wiki2/src/views/production.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
+pyramid.includes =
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/tutorial.db
 

diff --git a/pyramid/scaffolds/alchemy/development.ini_tmpl b/pyramid/scaffolds/alchemy/development.ini_tmpl
@@ -7,8 +7,9 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/{{project}}.db
 

diff --git a/pyramid/scaffolds/alchemy/production.ini_tmpl b/pyramid/scaffolds/alchemy/production.ini_tmpl
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
+pyramid.includes =
+    pyramid_tm
 
 sqlalchemy.url = sqlite:///%(here)s/{{project}}.db
 

diff --git a/pyramid/scaffolds/starter/development.ini_tmpl b/pyramid/scaffolds/starter/development.ini_tmpl
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
+pyramid.includes = 
+    pyramid_debugtoolbar
 
 [server:main]
 use = egg:waitress#main

diff --git a/pyramid/scaffolds/zodb/development.ini_tmpl b/pyramid/scaffolds/zodb/development.ini_tmpl
@@ -7,9 +7,11 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = true
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
-                   pyramid_zodbconn
-                   pyramid_tm
+pyramid.includes =
+    pyramid_debugtoolbar
+    pyramid_zodbconn
+    pyramid_tm
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000
 

diff --git a/pyramid/scaffolds/zodb/production.ini_tmpl b/pyramid/scaffolds/zodb/production.ini_tmpl
@@ -7,8 +7,10 @@ pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.debug_templates = false
 pyramid.default_locale_name = en
-pyramid.includes = pyramid_tm
-                   pyramid_zodbconn
+pyramid.includes =
+    pyramid_tm
+    pyramid_zodbconn
+
 tm.attempts = 3
 zodbconn.uri = file://%(here)s/Data.fs?connection_cache_size=20000