Changeset 11477

Timestamp:

7 Mar 2014, 12:04:38 (11 years ago)

Author:

Henrik Bettermann

Message:

Add more API docs (work in progress).

Location:

main/waeup.kofa/trunk

Files:

• docs/source/developerdocs/api/api_async.rst (added)
• docs/source/developerdocs/api/api_configuration.rst (added)
• docs/source/developerdocs/api/api_fees.rst (added)
• docs/source/developerdocs/api/api_imagestorage.rst (modified) (1 diff)
• docs/source/developerdocs/api/api_language.rst (added)
• docs/source/developerdocs/api/api_maintenance.rst (added)
• docs/source/developerdocs/api/api_objecthistory.rst (added)
• docs/source/developerdocs/api/api_reports.rst (added)
• docs/source/developerdocs/api/api_schema.rst (modified) (1 diff)
• docs/source/developerdocs/api/api_sourcefactory.rst (added)
• docs/source/developerdocs/api/api_webservices.rst (added)
• docs/source/developerdocs/api/api_widgets.rst (modified) (1 diff)
• docs/source/developerdocs/api/index.rst (modified) (1 diff)
• docs/source/developerdocs/api/schema/api_field.rst (modified) (1 diff)
• src/waeup/kofa/app.py (modified) (1 diff)
• src/waeup/kofa/configuration.py (modified) (1 diff)

main/waeup.kofa/trunk/docs/source/developerdocs/api/api_imagestorage.rst

@@ -1 @@
-`imagestorage` -- Storing images and other files
-************************************************
+`imagestorage` -- Image and File Storage Components Module
+**********************************************************
 
 .. automodule:: waeup.kofa.imagestorage

main/waeup.kofa/trunk/docs/source/developerdocs/api/api_schema.rst

@@ -1 @@
-`schema` -- Schema Fields
-*************************
+`schema` -- Special Schema Fields Package
+*****************************************
 
 (see also: :ref:`api-schema-modules`)

main/waeup.kofa/trunk/docs/source/developerdocs/api/api_widgets.rst

@@ -1 @@
-`widgets` -- Widgets
-********************
+`widgets` -- Special Widgets Package
+************************************
 
 (see also: :ref:`api-widgets-modules`)

main/waeup.kofa/trunk/docs/source/developerdocs/api/index.rst

@@ -16 +16 @@
    api_app
    api_applicants
+   api_async
    api_authentication
    api_browser
    api_catalog
+   api_configuration
    api_datacenter
+   api_fees
    api_hostels
    api_imagestorage
    api_interfaces
+   api_language
+   api_maintenance
+   api_objecthistory
    api_payments
    api_permissions
+   api_reports
    api_schema
+   api_sourcefactory
+   api_students
    api_university
    api_userscontainer
    api_utils
-   api_students
+   api_webservices
    api_widgets
    api_workflow

main/waeup.kofa/trunk/docs/source/developerdocs/api/schema/api_field.rst

@@ -1 @@
-`schema.field` - Special Fields
-*******************************
+`schema.field` - Special Schema Fields
+**************************************
 
 .. automodule:: waeup.kofa.schema.field

main/waeup.kofa/trunk/src/waeup/kofa/app.py

@@ -98 +98 @@
 @grok.subscribe(University, grok.IObjectAddedEvent)
 def handle_university_added(app, event):
+    """If a university is added, a message is logged.
+    """
     app.logger.info('University `%s` added.' % getattr(app, '__name__', None))
     return

main/waeup.kofa/trunk/src/waeup/kofa/configuration.py

@@ -17 +17 @@
 ##
 """
-Containers for session configuration objects.
+Components for portal configuration.
 """
 import grok