[ckan-changes] [okfn/ckan] 6d0bf3: [#2345] Beginning of autodoc API reference

Wed May 2 16:47:26 UTC 2012

Branch: refs/heads/feature-2345-action-api-autodocs
  Home:   https://github.com/okfn/ckan
  Commit: 6d0bf37f6bb1bd6688e2f8cac386b563f34b3a29
      https://github.com/okfn/ckan/commit/6d0bf37f6bb1bd6688e2f8cac386b563f34b3a29
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2012-05-02 (Wed, 02 May 2012)

  Changed paths:
    M ckan/logic/action/get.py
    A doc/api-ref.rst

  Log Message:
  -----------
  [#2345] Beginning of autodoc API reference

diff --git a/ckan/logic/action/get.py b/ckan/logic/action/get.py
index b2afe94..45677ad 100644
--- a/ckan/logic/action/get.py
+++ b/ckan/logic/action/get.py
@@ -1374,6 +1374,13 @@ def recently_changed_packages_activity_list_html(context, data_dict):
     The activity stream is rendered as a snippet of HTML meant to be included
     in an HTML page.
 
+    :param context: The current Pylons context.
+    :type context: dictionary
+    :param data_dict: The data dict.
+    :type data_dict: dicttionary
+    :returns: The recently changed activity list in HTML format.
+    :rtype: string
+
     '''
     activity_stream = recently_changed_packages_activity_list(context,
             data_dict)
diff --git a/doc/api-ref.rst b/doc/api-ref.rst
new file mode 100644
index 0000000..5c8a474
--- /dev/null
+++ b/doc/api-ref.rst
@@ -0,0 +1,9 @@
+.. index:: API_REF
+.. _api-ref:
+
+==================
+CKAN API Reference
+==================
+
+.. automodule:: ckan.logic.action.get
+   :members:


================================================================

