Fix up API docs.

zopefoundation · Jan 9, 2015 · 6257fd3 · 6257fd3
1 parent 41a6e4a
commit 6257fd3
Showing 1 changed file with 25 additions and 4 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,9 +1,30 @@
-:mod:`zope.annotation` API Documentation
-========================================
+:mod:`zope.annotation` API
+==========================
 
 
-Interfaces
-----------
+Framework Interfaces
+--------------------
+
+These interfaces define the source and targets for adaptation under the
+:mod:`zope.annotation` framework:
 
 .. automodule:: zope.annotation.interfaces
 
+   .. autointerface::  IAnnotatable
+
+   .. autointerface::  IAnnotations
+
+
+Attribute-Based Annotations
+---------------------------
+
+The default adapter implementation uses a special attribute,
+``__annotations__``, on the annotated object:
+
+.. autoclass:: zope.annotation.attribute.AttributeAnnotations
+
+Because setting an attribute is somewhat intrusive (as opposed to storing
+annotations elsewhere), this adapter requires that its context implment
+``IAttributeAnnotatable`` to signal that this attribute can be used.
+
+.. autointerface::  zope.annotation.interfaces.IAttributeAnnotatable