Permalink
Browse files

docs

  • Loading branch information...
1 parent efc5ce5 commit 25a9ce983f9a7e7facc8babe15e0a5730edfea07 @mcdonc mcdonc committed Apr 28, 2012
Showing with 19 additions and 2 deletions.
  1. +16 −0 docs/api.rst
  2. +1 −1 docs/conf.py
  3. +2 −1 substanced/interfaces.py
View
@@ -256,6 +256,13 @@ Other Helpers
.. autofunction:: includeme
+:mod:`substanced.properties` API
+--------------------------------
+
+.. automodule:: substanced.properties
+
+.. autoclass:: PropertySheet
+
:mod:`substanced.schema` API
----------------------------
@@ -309,3 +316,12 @@ Other Helpers
.. autofunction:: chunks
+:mod:`substanced.interfaces`
+----------------------------
+
+These represent interfaces implemented by various Substance D objects.
+
+.. automodule:: substanced.interfaces
+
+.. autointerface:: IPropertySheet
+ :members:
View
@@ -48,7 +48,7 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
-# 'repoze.sphinx.autointerface',
+ 'repoze.sphinx.autointerface',
]
# Looks for pyramid's objects
@@ -17,7 +17,8 @@ class IPropertied(Interface):
"""
class IPropertySheet(Interface):
""" Interface for objects with a set of properties defined by a Colander
- schema"""
+ schema. The class :class:`substanced.properties.PropertySheet` (which is
+ meant to be subclassed for specialization) implements this interface."""
context = Attribute('The context of the property sheet (a resource)')
request = Attribute('The current request')

0 comments on commit 25a9ce9

Please sign in to comment.