summaryrefslogtreecommitdiff
path: root/docs/api.txt
diff options
context:
space:
mode:
authorDomen Kožar <domen@dev.si>2013-02-23 18:58:48 +0100
committerDomen Kožar <domen@dev.si>2013-02-23 19:14:26 +0100
commit7e957687570b56d24fa487f2a94a30904f84f2f9 (patch)
treefbd6e834a9cf8e21b3aed200a29a77647e08b5ce /docs/api.txt
parent7dcefc26d4feaca5b475ed0d0fbab6e5ab8c4baf (diff)
downloadwebtest-7e957687570b56d24fa487f2a94a30904f84f2f9.tar.gz
Completely rewrite API documentation
Diffstat (limited to 'docs/api.txt')
-rw-r--r--docs/api.txt57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/api.txt b/docs/api.txt
new file mode 100644
index 0000000..f09da7c
--- /dev/null
+++ b/docs/api.txt
@@ -0,0 +1,57 @@
+:mod:`webtest` API
+==================
+
+.. automodule:: webtest
+
+:class:`webtest.app.TestApp`
+----------------------------
+
+.. autoclass:: webtest.app.TestApp
+ :members:
+
+:class:`webtest.app.TestRequest`
+--------------------------------
+
+.. autoclass:: webtest.app.TestRequest
+ :members:
+ :show-inheritance:
+
+
+:class:`webtest.response.TestResponse`
+--------------------------------------
+
+.. autoclass:: webtest.response.TestResponse
+ :members:
+ :show-inheritance:
+
+:mod:`webtest.forms`
+--------------------------------------
+
+.. automodule:: webtest.forms
+ :members:
+ :show-inheritance:
+ :inherited-members:
+
+
+:mod:`webtest.http`
+---------------------
+
+.. automodule:: webtest.http
+ :members:
+ :show-inheritance:
+
+
+:mod:`webtest.lint`
+---------------------
+
+.. automodule:: webtest.lint
+ :members:
+ :show-inheritance:
+
+
+:mod:`webtest.debugapp`
+---------------------
+
+.. automodule:: webtest.debugapp
+ :members:
+ :show-inheritance: