From ffa0ec8fa42e640143ace4071458075c99c1112c Mon Sep 17 00:00:00 2001 From: Chris Adams Date: Tue, 21 Sep 2010 13:58:18 -0400 Subject: [PATCH] Added class reference autodoc Among other things, this allows the more usable documentation to reference the class details without repetition. --- docs/conf.py | 2 +- docs/index.rst | 1 + docs/reference/api.rst | 5 +++++ docs/reference/authentication.rst | 5 +++++ docs/reference/authorization.rst | 5 +++++ docs/reference/bundle.rst | 5 +++++ docs/reference/cache.rst | 5 +++++ docs/reference/constants.rst | 6 ++++++ docs/reference/exceptions.rst | 5 +++++ docs/reference/fields.rst | 5 +++++ docs/reference/http.rst | 5 +++++ docs/reference/index.rst | 20 ++++++++++++++++++++ docs/reference/models.rst | 5 +++++ docs/reference/paginator.rst | 5 +++++ docs/reference/resources.rst | 5 +++++ docs/reference/serializers.rst | 5 +++++ docs/reference/throttle.rst | 5 +++++ tastypie/constants.py | 3 ++- 18 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 docs/reference/api.rst create mode 100644 docs/reference/authentication.rst create mode 100644 docs/reference/authorization.rst create mode 100644 docs/reference/bundle.rst create mode 100644 docs/reference/cache.rst create mode 100644 docs/reference/constants.rst create mode 100644 docs/reference/exceptions.rst create mode 100644 docs/reference/fields.rst create mode 100644 docs/reference/http.rst create mode 100644 docs/reference/index.rst create mode 100644 docs/reference/models.rst create mode 100644 docs/reference/paginator.rst create mode 100644 docs/reference/resources.rst create mode 100644 docs/reference/serializers.rst create mode 100644 docs/reference/throttle.rst diff --git a/docs/conf.py b/docs/conf.py index e556a3e0d..a0e66bf6c 100644 --- 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 index 419755c31..c7107e758 100644 --- 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 new file mode 100644 index 000000000..0e5326d53 --- /dev/null +++ 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 new file mode 100644 index 000000000..20dbce100 --- /dev/null +++ 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 new file mode 100644 index 000000000..4c1250ffb --- /dev/null +++ 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 new file mode 100644 index 000000000..9e9118989 --- /dev/null +++ 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 new file mode 100644 index 000000000..112cfecd2 --- /dev/null +++ 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 new file mode 100644 index 000000000..58b6e0b3a --- /dev/null +++ b/docs/reference/constants.rst @@ -0,0 +1,6 @@ +Constants +========= + +.. automodule:: tastypie.constants + :members: + :undoc-members: \ No newline at end of file diff --git a/docs/reference/exceptions.rst b/docs/reference/exceptions.rst new file mode 100644 index 000000000..154398b55 --- /dev/null +++ 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 new file mode 100644 index 000000000..3dd76ca83 --- /dev/null +++ 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 new file mode 100644 index 000000000..71d6c2e71 --- /dev/null +++ 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 new file mode 100644 index 000000000..04b0926c0 --- /dev/null +++ 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 new file mode 100644 index 000000000..fb0190c76 --- /dev/null +++ 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 new file mode 100644 index 000000000..c66f2ae22 --- /dev/null +++ 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 new file mode 100644 index 000000000..9e3e5e8e2 --- /dev/null +++ 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 new file mode 100644 index 000000000..f1f053bfc --- /dev/null +++ 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 new file mode 100644 index 000000000..2cd17cb3d --- /dev/null +++ b/docs/reference/throttle.rst @@ -0,0 +1,5 @@ +Throttle +======== + +.. automodule:: tastypie.throttle + :members: diff --git a/tastypie/constants.py b/tastypie/constants.py index 599503228..dbaa88b7c 100644 --- 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