Commits

Robert Brewer committed 979df03

A couple doc cleanups.

Comments (0)

Files changed (6)

cherrypy/_cpchecker.py

 class Checker(object):
     """A checker for CherryPy sites and their mounted applications.
     
-    on
-        set this to False to turn off the checker completely.
-    
     When this object is called at engine startup, it executes each
     of its own methods whose names start with ``check_``. If you wish
     to disable selected checks, simply add a line in your global
     """
     
     on = True
+    """If True (the default), run all checks; if False, turn off all checks."""
+    
     
     def __init__(self):
         self._populate_known_types()

sphinx/source/concepts/config.rst

 Builtin namespaces
 ------------------
 
+Entries from each namespace may be allowed in the global, application root
+(``"/"``) or per-path config, or a combination:
+
+==========  ======  ==================  =========
+Scope       Global  Application Root    App Path
+----------  ------  ------------------  ---------
+engine      X
+hooks       X       X                   X
+log         X       X
+request     X       X                   X
+response    X       X                   X
+server      X
+tools       X       X                   X
+==========  ======  ==================  =========
+
 engine
 ^^^^^^
 Entries in this namespace controls the 'application engine'. These can only be
-declared in the global config. Any attribute of `cherrypy.engine` may be set
+declared in the global config. Any attribute of
+:class:`cherrypy.engine<cherrypy.process.wspbus.Bus>` may be set
 in config; however, there are a few extra entries available in config:
 
- * Plugin attributes. Many of the :ref:`Engine Plugin<plugins>` are themselves
-   attributes of `engine`. You can set any attribute of an attached plugin
-   by simply naming it. For example, there is an instance of the
+ * Plugin attributes. Many of the :ref:`Engine Plugins<plugins>` are themselves
+   attributes of ``cherrypy.engine``. You can set any attribute of an attached
+   plugin by simply naming it. For example, there is an instance of the
    :class:`Autoreloader<cherrypy.process.plugins.Autoreloader>` class at
-   `engine.autoreload`; you can set its "frequency" attribute via the config
-   entry `engine.autoreload.frequency = 60`. In addition, you can turn such
-   plugins on and off by setting `engine.autoreload.on = True` or `False`.
- * `engine.SIGHUP/SIGTERM`: These entries can be used to set the list of
+   ``engine.autoreload``; you can set its "frequency" attribute via the config
+   entry ``engine.autoreload.frequency = 60``. In addition, you can turn such
+   plugins on and off by setting ``engine.autoreload.on = True`` or ``False``.
+ * ``engine.SIGHUP/SIGTERM``: These entries can be used to set the list of
    listeners for the given :ref:`channel<channels>`. Mostly, this is used
    to turn off the signal handling one gets automatically via
-   func:`cherrypy.quickstart`.
+   :func:`cherrypy.quickstart`.
 
 hooks
 ^^^^^
 
 Declares additional request-processing functions. Use this to append your own
 :class:`Hook<cherrypy._cprequest.Hook>` functions to the request. For example,
-to add `my_hook_func` to the `before_handler` hookpoint:
+to add ``my_hook_func`` to the ``before_handler`` hookpoint::
 
     [/]
     hooks.before_handler = myapp.my_hook_func
 ^^^
 
 Configures logging. These can only be declared in the global config (for global
-logging) or `[/]` config (for each application).
+logging) or ``[/]`` config (for each application).
 See :class:`LogManager<cherrypy._cplogging.LogManager>` for the list of
 configurable attributes. Typically, the "access_file", "error_file", and
 "screen" attributes are the most commonly configured.
 ^^^^^^
 Controls the default HTTP server via
 :class:`cherrypy.server<cherrypy._cpserver.Server>` (see that class for a
-complete list of configurable attribtues). These can only be
+complete list of configurable attributes). These can only be
 declared in the global config.
 
 tools
 Adds WSGI middleware to an Application's "pipeline". These can only be
 declared in the app's root config ("/").
 
- * `wsgi.pipeline`: Appends to the WSGi pipeline. The value must be a list of
+ * ``wsgi.pipeline``: Appends to the WSGi pipeline. The value must be a list of
    (name, app factory) pairs. Each app factory must be a WSGI callable class
    (or callable that returns a WSGI callable); it must take an initial
    'nextapp' argument, plus any optional keyword arguments. The optional
-   arguments may be configured via `wsgi.<name>.<arg>`.
- * `wsgi.response_class`: Overrides the default
+   arguments may be configured via ``wsgi.<name>.<arg>``.
+ * ``wsgi.response_class``: Overrides the default
    :class:`Response<cherrypy._cprequest.Response>` class.
 
-checker     Controls the 'checker', which looks for common errors in app state (including config) when the engine starts. Global config only.
-========    =======================
+checker
+^^^^^^^
 
-Entries from each namespace may be allowed in the global, application root (``"/"``) or per-path config, or a combination:
+Controls the "checker", which looks for common errors in app state (including
+config) when the engine starts. You can turn off individual checks by setting
+them to ``False`` in config. See :class:`cherrypy._cpchecker.Checker` for a
+complete list. Global config only.
 
-==========  ======  ==================  =========
-Scope       Global  Application Root    App Path
-----------  ------  ------------------  ---------
-engine      X
-hooks       X       X                   X
-log         X       X
-request     X       X                   X
-response    X       X                   X
-server      X
-tools       X       X                   X
-==========  ======  ==================  =========
 
 Custom config namespaces
 ------------------------

sphinx/source/intro/whycherrypy.rst

 7. Where to go from here?
 -------------------------
 
-Check out the :doc:`/intro/concepts/index` and :doc:`/progguide/index` for
+Check out the :doc:`/concepts/index` and :doc:`/progguide/index` for
 more complete documentation.
 

sphinx/source/progguide/REST.rst

 Within the CherryPy server, the remainder of the hierarchical
 identifier--the path--is mapped to Python objects
 via the Dispatch mechanism. This behavior is highly
-customizable and documented in :doc:`/intro/concepts/dispatching`.
+customizable and documented in :doc:`/concepts/dispatching`.
 
 Using the default dispatcher and page handlers, the path of the URI
 maps to a hierarchy of Python identifiers in the CherryPy app. For

sphinx/source/progguide/extending/customtools.rst

 path, a certain class, or even individual methods using the 
 :ref:`_cp_config <cp_config>` dictionary. Tools can also be used as decorators
 which provide syntactic sugar for configuring a tool for a specific callable.
-See :doc:`/intro/concepts/tools` for more information on how to use Tools.
+See :doc:`/concepts/tools` for more information on how to use Tools.
 This document will show you how to make your own.
 
 Your First Custom Tool

sphinx/source/refman/_cptools.rst

 :mod:`cherrypy._cptools`
 ************************
 
-See :doc:`/intro/concepts/tools` for a conceptual overview of CherryPy Tools.
+See :doc:`/concepts/tools` for a conceptual overview of CherryPy Tools.
 
 .. automodule:: cherrypy._cptools