Added API Reference to docs

2009-12-19 16:04:05 +00:00
parent 9d12dbad70
commit 8a646f0f4c
11 changed files with 101 additions and 22 deletions
--- a/docs/apireference.rst
+++ b/docs/apireference.rst
@@ -0,0 +1,46 @@
+API Reference
+=============
+
+Connecting
+----------
+
+.. autofunction:: mongoengine.connect
+
+Documents
+---------
+
+.. autoclass:: mongoengine.Document
+   :members:
+
+   .. attribute:: objects
+
+      A :class:`~mongoengine.queryset.QuerySet` object that is created lazily 
+      on access.
+
+.. autoclass:: mongoengine.EmbeddedDocument
+   :members:
+
+Querying
+--------
+
+.. autoclass:: mongoengine.queryset.QuerySet
+   :members:
+
+Fields
+------
+
+.. autoclass:: mongoengine.StringField
+
+.. autoclass:: mongoengine.IntField
+
+.. autoclass:: mongoengine.FloatField
+
+.. autoclass:: mongoengine.DateTimeField
+
+.. autoclass:: mongoengine.EmbeddedDocumentField
+
+.. autoclass:: mongoengine.ListField
+
+.. autoclass:: mongoengine.ObjectIdField
+
+.. autoclass:: mongoengine.ReferenceField