Initial docs for EntityProxyFields.

[philo.git] / docs / models / entities.rst

diff --git a/docs/models/entities.rst b/docs/models/entities.rst
index a834b13..4127f56 100644 (file)
--- a/docs/models/entities.rst
+++ b/docs/models/entities.rst
@@ -1,7 +1,7 @@
 Entities and Attributes
 =======================
 
 Entities and Attributes
 =======================
 

-.. module:: philo.models.base
+.. automodule:: 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`.
 
 
 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`.
 


@@ -10,25 +10,26 @@ Attributes
 ----------
 
 .. autoclass:: Attribute
 ----------
 
 .. autoclass:: Attribute

-   :members:
+       :members:

 
 .. autoclass:: AttributeValue
 
 .. autoclass:: AttributeValue

-   :members:
+       :members:

 
 .. automodule:: philo.models.base
 
 .. automodule:: philo.models.base

-   :members: attribute_value_limiter
+       :members: attribute_value_limiter

 
 .. autoclass:: JSONValue
 
 .. autoclass:: JSONValue

-   :show-inheritance:
+       :show-inheritance:

 
 .. autoclass:: ForeignKeyValue
 
 .. autoclass:: ForeignKeyValue

-   :show-inheritance:
+       :show-inheritance:

 
 .. autoclass:: ManyToManyValue
 
 .. autoclass:: ManyToManyValue

-   :show-inheritance:
+       :show-inheritance:

 
 .. automodule:: philo.models.base
 
 .. automodule:: philo.models.base

-   :members: value_content_type_limiter
+       :noindex:
+       :members: value_content_type_limiter

 
 .. autofunction:: register_value_model(model)
 .. autofunction:: unregister_value_model(model)
 
 .. autofunction:: register_value_model(model)
 .. autofunction:: unregister_value_model(model)


@@ -37,18 +38,19 @@ Entities
 --------
 
 .. autoclass:: Entity
 --------
 
 .. autoclass:: Entity

-   :members:
-   :exclude-members: attribute_set
+       :members:
+       :exclude-members: attribute_set

 
 .. autoclass:: TreeManager
 
 .. autoclass:: TreeManager

-   :members:
+       :members:

 
 .. autoclass:: TreeEntity
 
 .. autoclass:: TreeEntity

-   :members:
-   :exclude-members: attribute_set
+       :show-inheritance:
+       :members:
+       :exclude-members: attribute_set

 
 

-   .. attribute:: objects
+       .. attribute:: objects

 
 

-      An instance of :class:`TreeManager`.
-   
-   .. automethod:: get_path
\ No newline at end of file
+               An instance of :class:`TreeManager`.
+       
+       .. automethod:: get_path
\ No newline at end of file