X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/ba4bab73996c40c2551f7e5a0e478d0f553b8af3..refs/heads/gilbert-ext4:/docs/models/entities.rst

diff --git a/docs/models/entities.rst b/docs/models/entities.rst
index f381ead..b39a253 100644
--- a/docs/models/entities.rst
+++ b/docs/models/entities.rst
@@ -1,2 +1,55 @@
-Entities: the base class
-========================
\ No newline at end of file
+Entities and Attributes
+=======================
+
+.. module:: philo.models.base
+
+One of the core concepts in Philo is the relationship between the :class:`Entity` and :class:`Attribute` classes. :class:`Attribute`\ s represent an arbitrary key/value pair by having one :class:`GenericForeignKey` to an :class:`Entity` and another to an :class:`AttributeValue`.
+
+
+Attributes
+----------
+
+.. autoclass:: Attribute
+	:members:
+
+.. autoclass:: AttributeValue
+	:members:
+
+.. automodule:: philo.models.base
+	:noindex:
+	:members: attribute_value_limiter
+
+.. autoclass:: JSONValue
+	:show-inheritance:
+
+.. autoclass:: ForeignKeyValue
+	:show-inheritance:
+
+.. autoclass:: ManyToManyValue
+	:show-inheritance:
+
+.. automodule:: philo.models.base
+	:noindex:
+	:members: value_content_type_limiter
+
+.. autofunction:: register_value_model(model)
+.. autofunction:: unregister_value_model(model)
+
+Entities
+--------
+
+.. autoclass:: Entity
+	:members:
+
+.. autoclass:: TreeEntityManager
+	:members:
+
+.. autoclass:: TreeEntity
+	:show-inheritance:
+	:members:
+
+	.. attribute:: objects
+
+		An instance of :class:`TreeEntityManager`.
+	
+	.. automethod:: get_path
\ No newline at end of file