Commit 28169a07 authored by Tres Seaver's avatar Tres Seaver

Add autodoc for API reference.

parent 284b37c0
: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
......@@ -11,6 +11,8 @@ Contents:
.. toctree::
:maxdepth: 2
api
Overview
--------
......@@ -249,6 +251,7 @@ used only in a single program run. It can be disastrous if that BTree-based
structure is stored to a database, though.
.. doctest::
:options: +SKIP
>>> class C:
... pass
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment