Improve documentation around generate_stats.

Added a line for the 1.4 release which will contain this new
method.
Revised the sphinx method references for generate_stats and
process_response to actually link to each other. Following
the existing format to link to process_response lead to a
link being generated to Django's actual process_response
method on the middleware. I had to specifically mention the
toolbar's process_response and then updated the generate_stats
reference to be consistent between the two methods.

Author: tim-schilling

debug_toolbar/panels/__init__.py

@@ -168,10 +168,10 @@ def process_view(self, request, view_func, view_args, view_kwargs):
     def process_response(self, request, response):
         """
         Like process_response in Django's middleware. This is similar to
-        :meth:`generate_stats`, but will be executed on every request. It
-        should be used when either the logic needs to be executed on every
-        request or it needs to change the response entirely, such as
-        :class:`RedirectsPanel`.
+        :meth:`generate_stats <debug_toolbar.panels.Panel.generate_stats>`,
+        but will be executed on every request. It should be used when either
+        the logic needs to be executed on every request or it needs to change
+        the response entirely, such as :class:`RedirectsPanel`.
 
         Write panel logic related to the response there. Post-process data
         gathered while the view executed. Save data with :meth:`record_stats`.
@@ -181,9 +181,10 @@ def process_response(self, request, response):
 
     def generate_stats(self, request, response):
         """
-        Similar to :meth:`process_response`, but may not be executed on every
-        request. This will only be called if the toolbar will be inserted into
-        the request.
+        Similar to :meth:`process_response
+        <debug_toolbar.panels.Panel.process_response>`,
+        but may not be executed on every request. This will only be called if
+        the toolbar will be inserted into the request.
 
         Write panel logic related to the response there. Post-process data
         gathered while the view executed. Save data with :meth:`record_stats`.

debug_toolbar/panels/profiling.py

@@ -13,7 +13,7 @@
 # Occasionally the disable method on the profiler is listed before
 # the actual view functions. This function call should be ignored as
 # it leads to an error within the tests.
-INVALID_PROFILER_FUNC = "<method 'disable' of '_lsprof.Profiler' objects>"
+INVALID_PROFILER_FUNC = '_lsprof.Profiler'
 
 
 class DjangoDebugToolbarStats(Stats):

docs/changes.rst

@@ -1,6 +1,22 @@
 Change log
 ==========
 
+1.4
+---
+
+New features
+~~~~~~~~~~~~
+
+* New panel method :meth:`debug_toolbar.panels.Panel.generate_stats` allows panels
+  to only record stats when the toolbar is going to be inserted into the
+  response.
+
+Bugfixes
+~~~~~~~~
+
+* Response time for requests of projects with numerous media files has
+  been improved.
+
 1.3
 ---
 

docs/panels.rst

@@ -315,6 +315,8 @@ CSS API at this time.
 
     .. automethod:: debug_toolbar.panels.Panel.process_response
 
+    .. automethod:: debug_toolbar.panels.Panel.generate_stats
+
 .. _javascript-api:
 
 JavaScript API