summaryrefslogtreecommitdiff
path: root/docs/api-ref
diff options
context:
space:
mode:
authorgnowgi <nagarjun@gnowledge.org>2012-03-15 16:19:20 +0530
committergnowgi <nagarjun@gnowledge.org>2012-03-15 16:19:20 +0530
commit7a4f561e851fdc7246d804c3abb6748b8a4199a6 (patch)
treed2afc3463fd49625a9be482012f5c3bfcf7c42b9 /docs/api-ref
downloadgnowsys-7a4f561e851fdc7246d804c3abb6748b8a4199a6.tar.gz
master trunk of gnowsys-studio
Diffstat (limited to 'docs/api-ref')
-rw-r--r--docs/api-ref/zinnia.admin.rst43
-rw-r--r--docs/api-ref/zinnia.management.commands.rst51
-rw-r--r--docs/api-ref/zinnia.management.rst18
-rw-r--r--docs/api-ref/zinnia.rst106
-rw-r--r--docs/api-ref/zinnia.spam_checker.backends.rst43
-rw-r--r--docs/api-ref/zinnia.spam_checker.rst18
-rw-r--r--docs/api-ref/zinnia.templatetags.rst34
-rw-r--r--docs/api-ref/zinnia.url_shortener.backends.rst27
-rw-r--r--docs/api-ref/zinnia.url_shortener.rst18
-rw-r--r--docs/api-ref/zinnia.urls.rst99
-rw-r--r--docs/api-ref/zinnia.views.rst91
-rw-r--r--docs/api-ref/zinnia.xmlrpc.rst27
12 files changed, 575 insertions, 0 deletions
diff --git a/docs/api-ref/zinnia.admin.rst b/docs/api-ref/zinnia.admin.rst
new file mode 100644
index 0000000..6b5d2cb
--- /dev/null
+++ b/docs/api-ref/zinnia.admin.rst
@@ -0,0 +1,43 @@
+admin Package
+=============
+
+:mod:`admin` Package
+--------------------
+
+.. automodule:: zinnia.admin
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`category` Module
+----------------------
+
+.. automodule:: zinnia.admin.category
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`entry` Module
+-------------------
+
+.. automodule:: zinnia.admin.entry
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`forms` Module
+-------------------
+
+.. automodule:: zinnia.admin.forms
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`widgets` Module
+---------------------
+
+.. automodule:: zinnia.admin.widgets
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/api-ref/zinnia.management.commands.rst b/docs/api-ref/zinnia.management.commands.rst
new file mode 100644
index 0000000..b3590a9
--- /dev/null
+++ b/docs/api-ref/zinnia.management.commands.rst
@@ -0,0 +1,51 @@
+commands Package
+================
+
+:mod:`commands` Package
+-----------------------
+
+.. automodule:: zinnia.management.commands
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`blogger2zinnia` Module
+----------------------------
+
+.. automodule:: zinnia.management.commands.blogger2zinnia
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`feed2zinnia` Module
+-------------------------
+
+.. automodule:: zinnia.management.commands.feed2zinnia
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`spam_cleanup` Module
+--------------------------
+
+.. automodule:: zinnia.management.commands.spam_cleanup
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`wp2zinnia` Module
+-----------------------
+
+.. automodule:: zinnia.management.commands.wp2zinnia
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`zinnia2wp` Module
+-----------------------
+
+.. automodule:: zinnia.management.commands.zinnia2wp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/api-ref/zinnia.management.rst b/docs/api-ref/zinnia.management.rst
new file mode 100644
index 0000000..abd387c
--- /dev/null
+++ b/docs/api-ref/zinnia.management.rst
@@ -0,0 +1,18 @@
+management Package
+==================
+
+:mod:`management` Package
+-------------------------
+
+.. automodule:: zinnia.management
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ zinnia.management.commands
+
diff --git a/docs/api-ref/zinnia.rst b/docs/api-ref/zinnia.rst
new file mode 100644
index 0000000..c702bfa
--- /dev/null
+++ b/docs/api-ref/zinnia.rst
@@ -0,0 +1,106 @@
+Zinnia API
+==========
+
+.. contents::
+
+:mod:`zinnia` Package
+---------------------
+
+.. automodule:: zinnia.__init__
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`comparison` Module
+------------------------
+
+.. automodule:: zinnia.comparison
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`context_processors` Module
+--------------------------------
+
+.. automodule:: zinnia.context_processors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`feeds` Module
+-------------------
+
+.. automodule:: zinnia.feeds
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`managers` Module
+----------------------
+
+.. automodule:: zinnia.managers
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`models` Module
+--------------------
+
+.. automodule:: zinnia.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`moderator` Module
+-----------------------
+
+.. automodule:: zinnia.moderator
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`ping` Module
+------------------
+
+.. automodule:: zinnia.ping
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`search` Module
+--------------------
+
+.. automodule:: zinnia.search
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`signals` Module
+---------------------
+
+.. automodule:: zinnia.signals
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`sitemaps` Module
+----------------------
+
+.. automodule:: zinnia.sitemaps
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ zinnia.admin
+ zinnia.management
+ zinnia.spam_checker
+ zinnia.templatetags
+ zinnia.url_shortener
+ zinnia.urls
+ zinnia.views
+ zinnia.xmlrpc
diff --git a/docs/api-ref/zinnia.spam_checker.backends.rst b/docs/api-ref/zinnia.spam_checker.backends.rst
new file mode 100644
index 0000000..389a1a7
--- /dev/null
+++ b/docs/api-ref/zinnia.spam_checker.backends.rst
@@ -0,0 +1,43 @@
+backends Package
+================
+
+:mod:`backends` Package
+-----------------------
+
+.. automodule:: zinnia.spam_checker.backends
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`all_is_spam` Module
+-------------------------
+
+.. automodule:: zinnia.spam_checker.backends.all_is_spam
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`automattic` Module
+------------------------
+
+.. automodule:: zinnia.spam_checker.backends.automattic
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`mollom` Module
+--------------------
+
+.. automodule:: zinnia.spam_checker.backends.mollom
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`typepad` Module
+---------------------
+
+.. automodule:: zinnia.spam_checker.backends.typepad
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/api-ref/zinnia.spam_checker.rst b/docs/api-ref/zinnia.spam_checker.rst
new file mode 100644
index 0000000..efd2bbc
--- /dev/null
+++ b/docs/api-ref/zinnia.spam_checker.rst
@@ -0,0 +1,18 @@
+spam_checker Package
+====================
+
+:mod:`spam_checker` Package
+---------------------------
+
+.. automodule:: zinnia.spam_checker
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ zinnia.spam_checker.backends
+
diff --git a/docs/api-ref/zinnia.templatetags.rst b/docs/api-ref/zinnia.templatetags.rst
new file mode 100644
index 0000000..6a86c12
--- /dev/null
+++ b/docs/api-ref/zinnia.templatetags.rst
@@ -0,0 +1,34 @@
+templatetags Package
+====================
+
+:mod:`templatetags` Package
+---------------------------
+
+.. automodule:: zinnia.templatetags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`zbreadcrumbs` Module
+--------------------------
+
+.. automodule:: zinnia.templatetags.zbreadcrumbs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`zcalendar` Module
+-----------------------
+
+.. automodule:: zinnia.templatetags.zcalendar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`zinnia_admin_tags` Module
+-------------------------------
+
+.. automodule:: zinnia.templatetags.zinnia_admin_tags
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/api-ref/zinnia.url_shortener.backends.rst b/docs/api-ref/zinnia.url_shortener.backends.rst
new file mode 100644
index 0000000..dc022ad
--- /dev/null
+++ b/docs/api-ref/zinnia.url_shortener.backends.rst
@@ -0,0 +1,27 @@
+backends Package
+================
+
+:mod:`backends` Package
+-----------------------
+
+.. automodule:: zinnia.url_shortener.backends
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`bitly` Module
+-------------------
+
+.. automodule:: zinnia.url_shortener.backends.bitly
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`default` Module
+---------------------
+
+.. automodule:: zinnia.url_shortener.backends.default
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/api-ref/zinnia.url_shortener.rst b/docs/api-ref/zinnia.url_shortener.rst
new file mode 100644
index 0000000..33e0725
--- /dev/null
+++ b/docs/api-ref/zinnia.url_shortener.rst
@@ -0,0 +1,18 @@
+url_shortener Package
+=====================
+
+:mod:`url_shortener` Package
+----------------------------
+
+.. automodule:: zinnia.url_shortener
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ zinnia.url_shortener.backends
+
diff --git a/docs/api-ref/zinnia.urls.rst b/docs/api-ref/zinnia.urls.rst
new file mode 100644
index 0000000..b5638ee
--- /dev/null
+++ b/docs/api-ref/zinnia.urls.rst
@@ -0,0 +1,99 @@
+urls Package
+============
+
+:mod:`urls` Package
+-------------------
+
+.. automodule:: zinnia.urls
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`authors` Module
+---------------------
+
+.. automodule:: zinnia.urls.authors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`capabilities` Module
+--------------------------
+
+.. automodule:: zinnia.urls.capabilities
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`categories` Module
+------------------------
+
+.. automodule:: zinnia.urls.categories
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`discussions` Module
+-------------------------
+
+.. automodule:: zinnia.urls.discussions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`entries` Module
+---------------------
+
+.. automodule:: zinnia.urls.entries
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`feeds` Module
+-------------------
+
+.. automodule:: zinnia.urls.feeds
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`quick_entry` Module
+-------------------------
+
+.. automodule:: zinnia.urls.quick_entry
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`search` Module
+--------------------
+
+.. automodule:: zinnia.urls.search
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`sitemap` Module
+---------------------
+
+.. automodule:: zinnia.urls.sitemap
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`tags` Module
+------------------
+
+.. automodule:: zinnia.urls.tags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`trackback` Module
+-----------------------
+
+.. automodule:: zinnia.urls.trackback
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/api-ref/zinnia.views.rst b/docs/api-ref/zinnia.views.rst
new file mode 100644
index 0000000..1e22804
--- /dev/null
+++ b/docs/api-ref/zinnia.views.rst
@@ -0,0 +1,91 @@
+views Package
+=============
+
+:mod:`views` Package
+--------------------
+
+.. automodule:: zinnia.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`authors` Module
+---------------------
+
+.. automodule:: zinnia.views.authors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`categories` Module
+------------------------
+
+.. automodule:: zinnia.views.categories
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`channels` Module
+----------------------
+
+.. automodule:: zinnia.views.channels
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`decorators` Module
+------------------------
+
+.. automodule:: zinnia.views.decorators
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`entries` Module
+---------------------
+
+.. automodule:: zinnia.views.entries
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`quick_entry` Module
+-------------------------
+
+.. automodule:: zinnia.views.quick_entry
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`search` Module
+--------------------
+
+.. automodule:: zinnia.views.search
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`sitemap` Module
+---------------------
+
+.. automodule:: zinnia.views.sitemap
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`tags` Module
+------------------
+
+.. automodule:: zinnia.views.tags
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`trackback` Module
+-----------------------
+
+.. automodule:: zinnia.views.trackback
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/api-ref/zinnia.xmlrpc.rst b/docs/api-ref/zinnia.xmlrpc.rst
new file mode 100644
index 0000000..7974da4
--- /dev/null
+++ b/docs/api-ref/zinnia.xmlrpc.rst
@@ -0,0 +1,27 @@
+xmlrpc Package
+==============
+
+:mod:`xmlrpc` Package
+---------------------
+
+.. automodule:: zinnia.xmlrpc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`metaweblog` Module
+------------------------
+
+.. automodule:: zinnia.xmlrpc.metaweblog
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`pingback` Module
+----------------------
+
+.. automodule:: zinnia.xmlrpc.pingback
+ :members:
+ :undoc-members:
+ :show-inheritance:
+