[Checkins] SVN: BTrees/trunk/docs/ Add autodoc for API reference.

[Tres Seaver]

Log message for revision 128076:
  Add autodoc for API reference.

Changed:
  A   BTrees/trunk/docs/api.rst
  U   BTrees/trunk/docs/index.rst

-=-
Added: BTrees/trunk/docs/api.rst
===================================================================
--- BTrees/trunk/docs/api.rst	                        (rev 0)
+++ BTrees/trunk/docs/api.rst	2012-10-20 18:50:34 UTC (rev 128076)
@@ -0,0 +1,102 @@
+:mod:`BTrees` API Reference
+===========================
+
+
+Protocol APIs
+-------------
+
+.. automodule:: BTrees.Interfaces
+
+  .. autointerface:: ICollection
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IReadSequence
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IKeyed
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: ISetMutable
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: ISized
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IKeySequence
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IMinimalDictionary
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IDictionaryIsh
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IMerge
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IIMerge
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IMergeIntegerKey
+     :members:
+     :member-order: bysource
+
+Protocol APIs
+-------------
+
+.. automodule:: BTrees.Interfaces
+
+  .. autointerface:: ISet
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: ITreeSet
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IBTree
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IBTreeFamily
+     :members:
+     :member-order: bysource
+
+Module APIs
+-----------
+
+.. automodule:: BTrees.Interfaces
+
+  .. autointerface:: IBTreeModule
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IObjectObjectBTreeModule
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IIntegerObjectBTreeModule
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IObjectIntegerBTreeModule
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IIntegerIntegerBTreeModule
+     :members:
+     :member-order: bysource
+
+  .. autointerface:: IIntegerFloatBTreeModule
+     :members:
+     :member-order: bysource

Modified: BTrees/trunk/docs/index.rst
===================================================================
--- BTrees/trunk/docs/index.rst	2012-10-20 18:39:26 UTC (rev 128075)
+++ BTrees/trunk/docs/index.rst	2012-10-20 18:50:34 UTC (rev 128076)
@@ -11,6 +11,8 @@
 .. toctree::
    :maxdepth: 2
 
+   api
+
 Overview
 --------
 
@@ -249,6 +251,7 @@
 structure is stored to a database, though. 
 
 .. doctest::
+   :options: +SKIP
 
    >>> class C:
    ...     pass