Changeset 6505 for main


Ignore:
Timestamp:
4 Jul 2011, 16:00:20 (13 years ago)
Author:
Henrik Bettermann
Message:

Proposal for structuring the API - Part 2

Location:
main/waeup.sirp/trunk/docs/source/developerdocs/api
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/api_app.rst

    r5343 r6505  
    1 `waeup.sirp.app` -- Main application object
    2 *******************************************
     1`app` -- University Root (Site) Module
     2**************************************
    33
    44.. automodule:: waeup.sirp.app
    55   :members:
     6   :undoc-members:

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/api_applicants.rst

    r6500 r6505  
    1 `.applicants` - University Application Package
     1`applicants` - Application Components Package
    22*********************************************
    33
     4(see also: :ref:`api-applicants-modules`)
     5
    46.. automodule:: waeup.sirp.applicants
     7   :members:
     8   :undoc-members:
     9
     10.. _api-applicants-modules:
    511
    612Submodules

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/api_authentication.rst

    r5350 r6505  
    1 `waeup.sirp.authentication` -- Main application object
    2 ******************************************************
     1`authentication` -- Authentication Components Module
     2****************************************************
    33
    44.. automodule:: waeup.sirp.authentication
    55   :members:
     6   :undoc-members:

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

    r5350 r6505  
    1 `waeup.sirp.catalog` -- Cataloging Components
    2 *********************************************
     1`catalog` -- Cataloging Components Module
     2*****************************************
    33
    44.. automodule:: waeup.sirp.catalog
    55   :members:
     6   :undoc-members:

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/api_datacenter.rst

    r5350 r6505  
    1 `waeup.sirp.datacenter` -- The SIRP datacenter
    2 **********************************************
     1`datacenter` -- Datacenter Module
     2*********************************
    33
    44.. automodule:: waeup.sirp.datacenter
    55   :members:
     6   :undoc-members:

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

    r5664 r6505  
    1 `waeup.sirp.interfaces` - Main interfaces for SIRP components
    2 *************************************************************
     1`interfaces` - Main Interfaces Module
     2*************************************
    33
    44.. automodule:: waeup.sirp.interfaces
    55   :members:
     6   :undoc-members:
    67
    7 IWAeUPObject - Base interface for WAeUP objects
    8 ===============================================
    9 
    10 .. autointerface:: IWAeUPObject
     8.. autointerface:: waeup.sirp.interfaces.IUniversity
    119   :members:
    12 
    13 IUniversity - The main :mod:`waeup.sirp` component
    14 ==================================================
    15 
    16 .. autointerface:: IUniversity
    17    :members:
    18 
    19 IWAeUPContainer - A WAeUP-specific Container
    20 ============================================
    21 
    22 .. autointerface:: IWAeUPContainer
    23    :members:
    24 
    25 IWAeUPSIRPPluggable - A Plugin for :mod:`waeup.sirp` sites
    26 ==========================================================
    27 
    28 .. autointerface:: waeup.sirp.interfaces.IWAeUPSIRPPluggable
    29    :members:
     10   :undoc-members:

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/api_permissions.rst

    r5350 r6505  
    1 `waeup.sirp.permissions` -- Permissions and Roles
    2 *************************************************
     1`permissions` -- Permissions and Roles Components Module
     2********************************************************
    33
    44.. automodule:: waeup.sirp.permissions
    55   :members:
     6   :undoc-members:

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/api_users.rst

    r5350 r6505  
    1 `waeup.sirp.users` -- Users (Principals) and Related
    2 ****************************************************
     1`users` -- Users (Principals) Module
     2************************************
    33
    44.. automodule:: waeup.sirp.users
    55   :members:
     6   :undoc-members:

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

    r5350 r6505  
    1 `waeup.sirp.workflow` -- Workflows for `waeup.sirp` objects
    2 ***********************************************************
     1`workflow` -- Workflow Components Module
     2****************************************
    33
    44.. automodule:: waeup.sirp.workflow
    55   :members:
     6   :undoc-members:

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/applicants/api_container.rst

    r6501 r6505  
    1 `.applicants.container` - Containers for Applicants
    2 **************************************************
     1`applicants.container` - Container for Applicants
     2*************************************************
    33
    44.. automodule:: waeup.sirp.applicants.container

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

    r6501 r6505  
    1 `.applicants.interfaces` - University Application Related Interfaces
    2 *******************************************************************
     1`applicants.interfaces` - Applicants Related Interfaces
     2*******************************************************
    33
    44.. automodule:: waeup.sirp.applicants.interfaces

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/applicants/api_root.rst

    r6501 r6505  
    1 `.applicants.root` - Root for Application Containers
    2 ***************************************************
     1`applicants.root` - Root for Applicants Containers
     2**************************************************
    33
    44.. automodule:: waeup.sirp.applicants.root

  • main/waeup.sirp/trunk/docs/source/developerdocs/api/index.rst

    r6491 r6505  
    1 `waeup.sirp` API
    2 ****************
     1API
     2***
    33
    44.. automodule:: waeup.sirp
    55   :members:
    66
    7 This package provides the following subpackages:
     7Modules and Packages
     8--------------------
     9
     10`waeup.sirp` provides the following modules and subpackages:
    811
    912.. toctree::
    1013   :maxdepth: 1
    1114
    12    api_accesscodes
    1315   api_app
     16   api_interfaces
     17   api_authentication
     18   api_catalog
     19   api_permissions
     20   api_datacenter
     21   api_users
     22   api_workflow
     23   api_university
     24   api_browser
    1425   api_applicants
    1526   api_accesscodes
    16    api_authentication
    17    api_catalog
    18    api_datacenter
    19    api_interfaces
    20    api_permissions
    21    api_users
    22    api_workflow
     27   api_utils
     28
Note: See TracChangeset for help on using the changeset viewer.