summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.txt15
-rw-r--r--docs/modules/sel.txt3
-rw-r--r--docs/modules/webtest.txt11
3 files changed, 23 insertions, 6 deletions
diff --git a/docs/index.txt b/docs/index.txt
index 3954c36..f472102 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -2,6 +2,7 @@ Testing Applications with WebTest
+++++++++++++++++++++++++++++++++
:author: Ian Bicking <ianb@colorstudy.com>
+:maintainer: Gael Pasgrimaud <gael@gawel.org>
.. toctree::
:maxdepth: 1
@@ -75,10 +76,10 @@ run WSGI applications and verify the output.
TestApp
=======
-The most important object in WebTest is ``webtest.TestApp``, the
-wrapper for WSGI applications. To use it, you simply instantiate it
-with your WSGI application. (Note: if your WSGI application requires
-any configuration, you must set that up manually in your tests.)
+The most important object in WebTest is :class:`~webtest.TestApp`, the wrapper
+for WSGI applications. To use it, you simply instantiate it with your WSGI
+application. (Note: if your WSGI application requires any configuration, you
+must set that up manually in your tests.)
.. code-block:: python
@@ -89,7 +90,7 @@ any configuration, you must set that up manually in your tests.)
>>> res.status
'200 OK'
>>> res.form
- <webtest.app.Form object at ...>
+ <Form />
Making Requests
---------------
@@ -227,13 +228,15 @@ The added methods:
``response.forms``:
Return a dictionary of forms; you can use both indexes (refer to
the forms in order) or the string ids of forms (if you've given
- them ids) to identify the form. See `Form Submissions <#form-submissions>`_ for
+ them ids) to identify the form. See :ref:`form-submissions` for
more on the form objects.
``response.form``:
If there is just a single form, this returns that. It is an error
if you use this and there are multiple forms.
+.. _form-submissions:
+
Form Submissions
================
diff --git a/docs/modules/sel.txt b/docs/modules/sel.txt
index a3ab41e..f80b92c 100644
--- a/docs/modules/sel.txt
+++ b/docs/modules/sel.txt
@@ -47,10 +47,13 @@ Some of the return values return instances of these classes:
.. autoclass:: TestResponse
:members:
+
.. autoclass:: Document
:members:
+
.. autoclass:: Element
:members:
+
.. autoclass:: Form
:members:
diff --git a/docs/modules/webtest.txt b/docs/modules/webtest.txt
index 7f710fd..03a3d61 100644
--- a/docs/modules/webtest.txt
+++ b/docs/modules/webtest.txt
@@ -8,6 +8,7 @@ Module Contents
.. autoclass:: TestApp
:members:
+
.. autoexception:: AppError
Return Values
@@ -17,17 +18,27 @@ Some of the return values return instances of these classes:
.. autoclass:: TestResponse
:members:
+
.. autoclass:: TestRequest
:members:
+
.. autoclass:: Form
:members:
+
.. autoclass:: Field
+
.. autoclass:: Select
+
.. autoclass:: Radio
+
.. autoclass:: Checkbox
+
.. autoclass:: Text
+
.. autoclass:: Textarea
+
.. autoclass:: Hidden
+
.. autoclass:: Submit