summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2012-04-06 01:14:55 +0000
committerTres Seaver <tseaver@palladion.com>2012-04-06 01:14:55 +0000
commit791654f7b163cec69745df8ad89103daaebc637e (patch)
tree68c9ff057e1b1fac7289af5e2977a86d040f01a1 /docs
parentb154feeee7f7fce3684fe731bfc24c95d12cc648 (diff)
downloadzope-interface-791654f7b163cec69745df8ad89103daaebc637e.tar.gz
Add page for API docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst19
-rw-r--r--docs/index.rst1
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..8ea166d
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,19 @@
+:mod:`zope.interface` API Documentation
+=======================================
+
+:class:`zope.interface.interface.Specification`
+-----------------------------------------------
+
+Specification objects implement the API defined by
+:class:`zope.interface.interfaces.ISpecification`:
+
+.. autointerface:: zope.interface.interfaces.ISpecification
+ :members:
+ :member-order: bysource
+
+
+The Python implementation of Specification is ``SpecificationBasePy``.
+
+.. autoclass:: zope.interface.interface.SpecificationBasePy
+
+
diff --git a/docs/index.rst b/docs/index.rst
index 3751eee..55ae2d6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ Contents:
human
verify
foodforthought
+ api
hacking
По-русски