diff options
| -rw-r--r-- | sphinx/source/refman/_cpchecker.rst | 12 | ||||
| -rw-r--r-- | sphinx/source/refman/_cpconfig.rst | 18 | ||||
| -rw-r--r-- | sphinx/source/refman/cherrypy.rst | 8 | ||||
| -rw-r--r-- | sphinx/source/refman/dispatch.rst | 13 | ||||
| -rw-r--r-- | sphinx/source/refman/tree.rst | 61 |
5 files changed, 50 insertions, 62 deletions
diff --git a/sphinx/source/refman/_cpchecker.rst b/sphinx/source/refman/_cpchecker.rst new file mode 100644 index 00000000..68b87ee1 --- /dev/null +++ b/sphinx/source/refman/_cpchecker.rst @@ -0,0 +1,12 @@ +************************** +:mod:`cherrypy._cpchecker` +************************** + +.. automodule:: cherrypy._cpchecker + +Classes +======= + +.. autoclass:: Checker + :members: + diff --git a/sphinx/source/refman/_cpconfig.rst b/sphinx/source/refman/_cpconfig.rst new file mode 100644 index 00000000..b6c5ac4e --- /dev/null +++ b/sphinx/source/refman/_cpconfig.rst @@ -0,0 +1,18 @@ +************************* +:mod:`cherrypy._cpconfig` +************************* + +.. automodule:: cherrypy._cpconfig + +Classes +======= + +.. autoclass:: Config + :members: + :inherited-members: + +Functions +========= + +.. autofunction:: merge + diff --git a/sphinx/source/refman/cherrypy.rst b/sphinx/source/refman/cherrypy.rst index 39919061..e2874e4d 100644 --- a/sphinx/source/refman/cherrypy.rst +++ b/sphinx/source/refman/cherrypy.rst @@ -1,12 +1,12 @@ - +*************** :mod:`cherrypy` -================= +*************** .. automodule:: cherrypy Classes -------- +======= .. autoclass:: HTTPError :members: @@ -28,7 +28,7 @@ Classes Functions ----------- +========= .. autofunction:: expose diff --git a/sphinx/source/refman/dispatch.rst b/sphinx/source/refman/dispatch.rst index bff7774e..28c333a4 100644 --- a/sphinx/source/refman/dispatch.rst +++ b/sphinx/source/refman/dispatch.rst @@ -1,13 +1,12 @@ - -:mod:`cherrypy.dispatch` -- Mapping URI's to handlers -====================================================== - -.. this dummy here just gives cross refs a place to look at - -.. module:: cherrypy.dispatch +******************************************************** +:mod:`cherrypy._cpdispatch` -- Mapping URI's to handlers +******************************************************** .. automodule:: cherrypy._cpdispatch +Classes +======= + .. autoclass:: PageHandler :members: diff --git a/sphinx/source/refman/tree.rst b/sphinx/source/refman/tree.rst index ae57a3a1..7df25387 100644 --- a/sphinx/source/refman/tree.rst +++ b/sphinx/source/refman/tree.rst @@ -1,56 +1,15 @@ -.. - This is not ideally documented at the moment. - - There's no way to describe the module as it appears at runtime, - but then reference the docstrings from the actual objects. - - This should really be trying to document the class cherrypy._cptree.Tree +*********************** +:mod:`cherrypy._cptree` +*********************** - Would love if I could map the autodocs to the right place - .. automethod:: cherrypy._cptree.Tree.script_name +.. automodule:: cherrypy._cptree +Classes +======= +.. autoclass:: Application + :members: - -:mod:`cherrypy.tree` -==================== - -.. module:: cherrypy.tree - -The global registry of CherryPy applications, mounted at diverse points. - -This is actually an instance of a Tree class instead of a module. -An instance may also be used as a WSGI callable (WSGI application object), -in which case it dispatches to all mounted apps. - - -.. function:: mount(root, script_name='', config=None) - - Mount a new app from a root object, script_name, and config. - - root: an instance of a "controller class" (a collection of page - handler methods) which represents the root of the application. - This may also be an Application instance, or None if using - a dispatcher other than the default. - - script_name: a string containing the "mount point" of the application. - This should start with a slash, and be the path portion of the - URL at which to mount the given root. For example, if root.index() - will handle requests to "http://www.example.com:8080/dept/app1/", - then the script_name argument would be "/dept/app1". - - It MUST NOT end in a slash. If the script_name refers to the - root of the URI, it MUST be an empty string (not "/"). - - config: a file or dict containing application config. - -.. function:: graft(wsgi_callable, script_name='') - - Mount a wsgi callable at the given script_name. - -.. function:: script_name - - The script_name of the app at the given path, or None. - - If path is None, cherrypy.request is used. +.. autoclass:: Tree + :members: |