From 51b2f9457a852956342518683f5c13d9da394b52 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@agendaless.com>
Date: Wed, 8 Sep 2010 05:01:26 +0000
Subject: - The ``repoze.bfg.interfaces`` API documentation page is now
 rendered   via ``repoze.sphinx.autointerface``.

- The URL Dispatch narrative chapter now refers to the ``interfaces``
  chapter to explain the API of an ``IRoute`` object.

- ``tests_require`` now includes ``repoze.sphinx.autointerface`` as a
  dependency.
---
 docs/api/interfaces.rst   | 14 +++++++++-----
 docs/conf.py              |  3 ++-
 docs/narr/urldispatch.rst |  6 +++++-
 3 files changed, 16 insertions(+), 7 deletions(-)

(limited to 'docs')

diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index e024fcff7..934322594 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -8,17 +8,21 @@
 Event-Related Interfaces
 ++++++++++++++++++++++++
 
-  .. autoclass:: IAfterTraversal
+  .. autointerface:: IAfterTraversal
 
-  .. autoclass:: INewRequest
+  .. autointerface:: INewRequest
 
-  .. autoclass:: INewResponse
+  .. autointerface:: INewResponse
 
-  .. autoclass:: IWSGIApplicationCreatedEvent
+  .. autointerface:: IWSGIApplicationCreatedEvent
 
 Other Interfaces
 ++++++++++++++++
 
-  .. autoclass:: IExceptionResponse
+  .. autointerface:: IExceptionResponse
+
+  .. autointerface:: IRoutesMapper
+
+  .. autointerface:: IRoute
 
 
diff --git a/docs/conf.py b/docs/conf.py
index 2f01288b7..2b417ff74 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -41,7 +41,8 @@ for item in os.listdir(parent):
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
+              'repoze.sphinx.autointerface']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst
index 6a5a24c81..2f1a235a7 100644
--- a/docs/narr/urldispatch.rst
+++ b/docs/narr/urldispatch.rst
@@ -657,7 +657,8 @@ current :term:`request` object.
 The ``info`` dictionary has a number of contained values: ``match`` is
 a dictionary: it represents the arguments matched in the URL by the
 route.  ``route`` is an object representing the route which was
-matched.
+matched (see ``IRoute`` in :ref:`interfaces_module` for the API of
+such a route object).
 
 ``info['match']`` is useful when predicates need access to the route
 match.  For example:
@@ -749,6 +750,9 @@ The above predicate, when added to a number of route configurations
 ensures that the year match argument is '2010' if and only if the
 route name is 'ymd', 'ym', or 'y'.
 
+See also ``IRoute`` in :ref:`interfaces_module` for more API
+documentation about a route object.
+
 Route Matching
 --------------
 
-- 
cgit v1.2.3