summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-08-20 23:25:52 -0400
committerChris McDonough <chrism@plope.com>2011-08-20 23:25:52 -0400
commit2c9f3c76403b9a70bf0578f44deab11208b5a542 (patch)
treed5213cab536b55e60938f94652cfd0f0d7e407d5
parent712de76db8a93e830844d24ce277b929d8da6412 (diff)
downloadpyramid-2c9f3c76403b9a70bf0578f44deab11208b5a542.tar.gz
pyramid-2c9f3c76403b9a70bf0578f44deab11208b5a542.tar.bz2
pyramid-2c9f3c76403b9a70bf0578f44deab11208b5a542.zip
- Mention debug toolbar in tutorials.
-rw-r--r--TODO.txt2
-rw-r--r--docs/narr/project.rst64
-rw-r--r--docs/tutorials/wiki/installation.rst9
-rw-r--r--docs/tutorials/wiki2/installation.rst5
4 files changed, 47 insertions, 33 deletions
diff --git a/TODO.txt b/TODO.txt
index 7ae6a570a..426368be5 100644
--- a/TODO.txt
+++ b/TODO.txt
@@ -6,8 +6,6 @@ Should-Have
- Name WSGI app "main" instead of pipeline in scaffold configs?
-- Mention debug toolbar in tutorials.
-
Nice-to-Have
------------
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index aed93f9c5..d259a9c79 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -309,6 +309,14 @@ browser like what is displayed in the following image:
This is the page shown by default when you visit an unmodified ``paster
create`` -generated ``pyramid_starter`` application in a browser.
+.. index::
+ single: debug toolbar
+
+.. _debug_toolbar:
+
+The Debug Toolbar
+~~~~~~~~~~~~~~~~~
+
If you click on the image shown at the right hand top of the page ("^DT"),
you'll be presented with a debug toolbar that provides various niceties while
you're developing. This image will float above every HTML page served by
@@ -348,33 +356,6 @@ Put a hash mark in front of the ``pyramid.includes`` line:
Then restart the application to see that the toolbar has been turned off.
-.. sidebar:: Using an Alternate WSGI Server
-
- The code generated by a :app:`Pyramid` scaffold assumes that you
- will be using the ``paster serve`` command to start your application while
- you do development. However, ``paster serve`` is by no means the only way
- to start up and serve a :app:`Pyramid` application. As we saw in
- :ref:`firstapp_chapter`, ``paster serve`` needn't be invoked at all to run
- a :app:`Pyramid` application. The use of ``paster serve`` to run a
- :app:`Pyramid` application is purely conventional based on the output of
- its scaffold.
-
- Any :term:`WSGI` server is capable of running a :app:`Pyramid`
- application. Some WSGI servers don't require the :term:`PasteDeploy`
- framework's ``paster serve`` command to do server process management at
- all. Each :term:`WSGI` server has its own documentation about how it
- creates a process to run an application, and there are many of them, so we
- cannot provide the details for each here. But the concepts are largely
- the same, whatever server you happen to use.
-
- One popular production alternative to a ``paster``-invoked server is
- :term:`mod_wsgi`. You can also use :term:`mod_wsgi` to serve your
- :app:`Pyramid` application using the Apache web server rather than any
- "pure-Python" server that is started as a result of ``paster serve``. See
- :ref:`modwsgi_tutorial` for details. However, it is usually easier to
- *develop* an application using a ``paster serve`` -invoked webserver, as
- exception and debugging output will be sent to the console.
-
.. index::
single: project structure
@@ -1002,5 +983,30 @@ configuration as would be loaded if you were running your Pyramid application
via ``paster serve``. This can be a useful debugging tool. See
:ref:`interactive_shell` for more details.
-
-
+Using an Alternate WSGI Server
+------------------------------
+
+The code generated by a :app:`Pyramid` scaffold assumes that you will be
+using the ``paster serve`` command to start your application while you do
+development. However, ``paster serve`` is by no means the only way to start
+up and serve a :app:`Pyramid` application. As we saw in
+:ref:`firstapp_chapter`, ``paster serve`` needn't be invoked at all to run a
+:app:`Pyramid` application. The use of ``paster serve`` to run a
+:app:`Pyramid` application is purely conventional based on the output of its
+scaffold.
+
+Any :term:`WSGI` server is capable of running a :app:`Pyramid` application.
+Some WSGI servers don't require the :term:`PasteDeploy` framework's ``paster
+serve`` command to do server process management at all. Each :term:`WSGI`
+server has its own documentation about how it creates a process to run an
+application, and there are many of them, so we cannot provide the details for
+each here. But the concepts are largely the same, whatever server you happen
+to use.
+
+One popular production alternative to a ``paster``-invoked server is
+:term:`mod_wsgi`. You can also use :term:`mod_wsgi` to serve your
+:app:`Pyramid` application using the Apache web server rather than any
+"pure-Python" server that is started as a result of ``paster serve``. See
+:ref:`modwsgi_tutorial` for details. However, it is usually easier to
+*develop* an application using a ``paster serve`` -invoked webserver, as
+exception and debugging output will be sent to the console.
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index 28d9eb152..f3e22324c 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -244,8 +244,13 @@ missing some test coverage, particularly in the file named
Visit the Application in a Browser
==================================
-In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_.
-You will see the generated application's default page.
+In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_. You
+will see the generated application's default page.
+
+One thing you'll notice is the "debug toolbar" icon on right hand side of the
+page. You can read more about the purpose of the icon at
+:ref:`debug_toolbar`. It allows you to get information about your
+application while you develop.
Decisions the ``pyramid_zodb`` Scaffold Has Made For You
========================================================
diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst
index 2ea20dcb0..488b4fb35 100644
--- a/docs/tutorials/wiki2/installation.rst
+++ b/docs/tutorials/wiki2/installation.rst
@@ -217,6 +217,11 @@ Visit the Application in a Browser
In a browser, visit ``http://localhost:6543/``. You will see the
generated application's default page.
+One thing you'll notice is the "debug toolbar" icon on right hand side of the
+page. You can read more about the purpose of the icon at
+:ref:`debug_toolbar`. It allows you to get information about your
+application while you develop.
+
Decisions the ``pyramid_routesalchemy`` Scaffold Has Made For You
=================================================================