Changeset 6515

Timestamp:

6 Jul 2011, 13:45:28 (13 years ago)

Author:

Henrik Bettermann

Message:

Proposal for structuring the API - Part 4

Location:

main/waeup.sirp/trunk

Files:

• docs/source/developerdocs/api/accesscodes/api_accesscodes.rst (moved) (moved from main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_accesscodes_accesscodes.rst) (1 diff)
• docs/source/developerdocs/api/accesscodes/api_browser.rst (moved) (moved from main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_accesscodes_browser.rst) (1 diff)
• docs/source/developerdocs/api/accesscodes/api_catalog.rst (moved) (moved from main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_accesscodes_catalog.rst) (1 diff)
• docs/source/developerdocs/api/accesscodes/api_interfaces.rst (moved) (moved from main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_accesscodes_interfaces.rst) (1 diff)
• docs/source/developerdocs/api/accesscodes/api_workflow.rst (moved) (moved from main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_accesscodes_workflow.rst) (1 diff)
• docs/source/developerdocs/api/api_accesscodes.rst (modified) (2 diffs)
• src/waeup/sirp/accesscodes/__init__.py (modified) (1 diff)

main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_accesscodes.rst

@@ -1 @@
-`waeup.sirp.accesscodes.accesscodes` -- Access Codes
-****************************************************
+`accesscodes.accesscodes` -- AC Components
+******************************************
 
 .. automodule:: waeup.sirp.accesscodes.accesscodes

main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_browser.rst

@@ -1 @@
-`waeup.sirp.accesscodes.browser` -- UI components
-*************************************************
+`accesscodes.browser` -- AC UI Components
+*****************************************
 
 .. automodule:: waeup.sirp.accesscodes.browser

main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_catalog.rst

@@ -1 @@
-`waeup.sirp.accesscodes.catalog` -- The accesscodes catalog
-***********************************************************
-
-.. py:module:: waeup.sirp.accesscodes.catalog
+`accesscodes.catalog` -- AC Catalog Components
+**********************************************
 
 .. automodule:: waeup.sirp.accesscodes.catalog

main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_interfaces.rst

@@ -1 @@
-`waeup.sirp.accesscodes.interfaces` -- The accesscodes interfaces
-*****************************************************************
+`accesscodes.interfaces` -- AC Interfaces
+*****************************************
 
 .. automodule:: waeup.sirp.accesscodes.interfaces

main/waeup.sirp/trunk/docs/source/developerdocs/api/accesscodes/api_workflow.rst

@@ -1 @@
-`waeup.sirp.accesscodes.workflow` - Workflows for accesscodes
-*************************************************************
+`accesscodes.workflow` - AC Workflow Components
+***********************************************
 
 .. automodule:: waeup.sirp.accesscodes.workflow

main/waeup.sirp/trunk/docs/source/developerdocs/api/api_accesscodes.rst

@@ -1 @@
-`waeup.sirp.accesscodes` -- Access Codes
-****************************************
+`accesscodes` -- Access Codes Package
+*************************************
 
 (see also: :ref:`api-accesscodes-modules`)
@@ -18 +18 @@
    :maxdepth: 1
 
-   api_accesscodes_accesscodes
-   api_accesscodes_browser
-   api_accesscodes_catalog
-   api_accesscodes_interfaces
-   api_accesscodes_workflow
+   accesscodes/api_accesscodes
+   accesscodes/api_browser
+   accesscodes/api_catalog
+   accesscodes/api_interfaces
+   accesscodes/api_workflow

main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/__init__.py

@@ -1 @@
-"""Access codes (aka PINs)
---------------------------
-
+"""
 Access codes are special objects used for identifying users. Each
 access code has a portal-wide unique number.