Added class reference autodoc

Among other things, this allows the more usable documentation to reference the class details without repetition.
uberj · Sep 21, 2010 · ffa0ec8 · ffa0ec8
1 parent 66da967
commit ffa0ec8
Show file tree

Hide file tree

Showing 18 changed files with 95 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.intersphinx']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,3 +10,4 @@ interfaces.
 
    tutorial
    settings
+   reference/index.rst
diff --git a/docs/reference/api.rst b/docs/reference/api.rst
@@ -0,0 +1,5 @@
+API
+===
+
+.. automodule:: tastypie.api
+    :members:
diff --git a/docs/reference/authentication.rst b/docs/reference/authentication.rst
@@ -0,0 +1,5 @@
+Authentication
+==============
+
+.. automodule:: tastypie.authentication
+    :members:
diff --git a/docs/reference/authorization.rst b/docs/reference/authorization.rst
@@ -0,0 +1,5 @@
+Authorization
+=============
+
+.. automodule:: tastypie.authorization
+    :members:
diff --git a/docs/reference/bundle.rst b/docs/reference/bundle.rst
@@ -0,0 +1,5 @@
+Bundle
+======
+
+.. automodule:: tastypie.bundle
+    :members:
diff --git a/docs/reference/cache.rst b/docs/reference/cache.rst
@@ -0,0 +1,5 @@
+Cache
+=====
+
+.. automodule:: tastypie.cache
+    :members:
diff --git a/docs/reference/constants.rst b/docs/reference/constants.rst
@@ -0,0 +1,6 @@
+Constants
+=========
+
+.. automodule:: tastypie.constants
+    :members:
+    :undoc-members:
diff --git a/docs/reference/exceptions.rst b/docs/reference/exceptions.rst
@@ -0,0 +1,5 @@
+Exceptions
+==========
+
+.. automodule:: tastypie.exceptions
+    :members:
diff --git a/docs/reference/fields.rst b/docs/reference/fields.rst
@@ -0,0 +1,5 @@
+Fields
+======
+
+.. automodule:: tastypie.fields
+    :members:
diff --git a/docs/reference/http.rst b/docs/reference/http.rst
@@ -0,0 +1,5 @@
+HTTP
+====
+
+.. automodule:: tastypie.http
+    :members:
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -0,0 +1,20 @@
+Tastypie Module Reference
+=========================
+
+.. toctree::
+   :maxdepth: 2
+
+   api.rst
+   authentication.rst
+   authorization.rst
+   bundle.rst
+   cache.rst
+   constants.rst
+   exceptions.rst
+   fields.rst
+   http.rst
+   models.rst
+   paginator.rst
+   resources.rst
+   serializers.rst
+   throttle.rst
diff --git a/docs/reference/models.rst b/docs/reference/models.rst
@@ -0,0 +1,5 @@
+Modles
+======
+
+.. automodule:: tastypie.models
+    :members:
diff --git a/docs/reference/paginator.rst b/docs/reference/paginator.rst
@@ -0,0 +1,5 @@
+Paginator
+=========
+
+.. automodule:: tastypie.paginator
+    :members:
diff --git a/docs/reference/resources.rst b/docs/reference/resources.rst
@@ -0,0 +1,5 @@
+Resources
+=========
+
+.. automodule:: tastypie.resources
+    :members:
diff --git a/docs/reference/serializers.rst b/docs/reference/serializers.rst
@@ -0,0 +1,5 @@
+Serializers
+===========
+
+.. automodule:: tastypie.serializers
+    :members:
diff --git a/docs/reference/throttle.rst b/docs/reference/throttle.rst
@@ -0,0 +1,5 @@
+Throttle
+========
+
+.. automodule:: tastypie.throttle
+    :members:
diff --git a/tastypie/constants.py b/tastypie/constants.py
@@ -1,3 +1,4 @@
-# For filtering...
+#: Enable all basic ORM filters but do not allow filtering across relationships 
 ALL = 1
+#: Enable all ORM filters, including across relationships
 ALL_WITH_RELATIONS = 2