summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/testing.rst10
-rw-r--r--docs/index.rst2
-rw-r--r--docs/narr/unittesting.rst13
3 files changed, 25 insertions, 0 deletions
diff --git a/docs/api/testing.rst b/docs/api/testing.rst
new file mode 100644
index 000000000..da0a128d9
--- /dev/null
+++ b/docs/api/testing.rst
@@ -0,0 +1,10 @@
+.. _testing_module:
+
+:mod:`repoze.bfg.testing`
+==========================
+
+.. automodule:: repoze.bfg.testing
+
+ .. autoclass:: BFGTestCase
+ :members:
+
diff --git a/docs/index.rst b/docs/index.rst
index e89c18494..0c8fd295e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -35,6 +35,7 @@ Narrative documentation in chapter form explaining how to use
narr/security
narr/events
narr/environment
+ narr/unittesting
changes
glossary
@@ -72,6 +73,7 @@ Per-module :mod:`repoze.bfg` API documentation.
api/router
api/security
api/template
+ api/testing
api/traversal
api/location
api/urldispatch
diff --git a/docs/narr/unittesting.rst b/docs/narr/unittesting.rst
new file mode 100644
index 000000000..0ef04083f
--- /dev/null
+++ b/docs/narr/unittesting.rst
@@ -0,0 +1,13 @@
+.. _unittesting_chapter:
+
+Unit Testing
+============
+
+:mod:`repoze.bfg` provides helper facilities for writing
+``unittest.TestCase`` -derived tests. A base class for these types of
+tests as well as functions that help test BFG applications
+specifically exist. See the :ref:`testing_module` chapter for the
+API.
+
+XXX
+