[Checkins] SVN: Products.DCWorkflow/trunk/docs/ Added API documentation.

Charlie Clark cvs-admin at zope.org
Thu Apr 5 16:02:52 UTC 2012


Log message for revision 124971:
  Added API documentation.

Changed:
  A   Products.DCWorkflow/trunk/docs/api/
  A   Products.DCWorkflow/trunk/docs/api/DCWorkflow.browser.rst
  A   Products.DCWorkflow/trunk/docs/api/DCWorkflow.rst
  A   Products.DCWorkflow/trunk/docs/api/modules.rst
  U   Products.DCWorkflow/trunk/docs/index.rst

-=-
Added: Products.DCWorkflow/trunk/docs/api/DCWorkflow.browser.rst
===================================================================
--- Products.DCWorkflow/trunk/docs/api/DCWorkflow.browser.rst	                        (rev 0)
+++ Products.DCWorkflow/trunk/docs/api/DCWorkflow.browser.rst	2012-04-05 16:02:48 UTC (rev 124971)
@@ -0,0 +1,19 @@
+browser Package
+===============
+
+:mod:`browser` Package
+----------------------
+
+.. automodule:: Products.DCWorkflow.browser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`workflow` Module
+----------------------
+
+.. automodule:: Products.DCWorkflow.browser.workflow
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

Added: Products.DCWorkflow/trunk/docs/api/DCWorkflow.rst
===================================================================
--- Products.DCWorkflow/trunk/docs/api/DCWorkflow.rst	                        (rev 0)
+++ Products.DCWorkflow/trunk/docs/api/DCWorkflow.rst	2012-04-05 16:02:48 UTC (rev 124971)
@@ -0,0 +1,145 @@
+DCWorkflow Package
+==================
+
+:mod:`DCWorkflow` Package
+-------------------------
+
+.. automodule:: Products.DCWorkflow.__init__
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`ContainerTab` Module
+--------------------------
+
+.. automodule:: Products.DCWorkflow.ContainerTab
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`DCWorkflow` Module
+------------------------
+
+.. automodule:: Products.DCWorkflow.DCWorkflow
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`Expression` Module
+------------------------
+
+.. automodule:: Products.DCWorkflow.Expression
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`Guard` Module
+-------------------
+
+.. automodule:: Products.DCWorkflow.Guard
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`Scripts` Module
+---------------------
+
+.. automodule:: Products.DCWorkflow.Scripts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`States` Module
+--------------------
+
+.. automodule:: Products.DCWorkflow.States
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`Transitions` Module
+-------------------------
+
+.. automodule:: Products.DCWorkflow.Transitions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`Variables` Module
+-----------------------
+
+.. automodule:: Products.DCWorkflow.Variables
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`WorkflowUIMixin` Module
+-----------------------------
+
+.. automodule:: Products.DCWorkflow.WorkflowUIMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`Worklists` Module
+-----------------------
+
+.. automodule:: Products.DCWorkflow.Worklists
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`events` Module
+--------------------
+
+.. automodule:: Products.DCWorkflow.events
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`exportimport` Module
+--------------------------
+
+.. automodule:: Products.DCWorkflow.exportimport
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`interfaces` Module
+------------------------
+
+.. automodule:: Products.DCWorkflow.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`permissions` Module
+-------------------------
+
+.. automodule:: Products.DCWorkflow.permissions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`testing` Module
+---------------------
+
+.. automodule:: Products.DCWorkflow.testing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`utils` Module
+-------------------
+
+.. automodule:: Products.DCWorkflow.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    DCWorkflow.browser

Added: Products.DCWorkflow/trunk/docs/api/modules.rst
===================================================================
--- Products.DCWorkflow/trunk/docs/api/modules.rst	                        (rev 0)
+++ Products.DCWorkflow/trunk/docs/api/modules.rst	2012-04-05 16:02:48 UTC (rev 124971)
@@ -0,0 +1,7 @@
+DCWorkflow
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   DCWorkflow

Modified: Products.DCWorkflow/trunk/docs/index.rst
===================================================================
--- Products.DCWorkflow/trunk/docs/index.rst	2012-04-05 13:17:24 UTC (rev 124970)
+++ Products.DCWorkflow/trunk/docs/index.rst	2012-04-05 16:02:48 UTC (rev 124971)
@@ -7,4 +7,5 @@
    :maxdepth: 2
 
    narrative/index
+   api/modules
 



More information about the checkins mailing list