Changeset 4273 for waeup

Timestamp:

13 Jun 2009, 11:35:46 (16 years ago)

Author:

uli

Message:

Make app.txt sphinx-aware.

File:

• waeup/branches/ulif-rewrite/src/waeup/app.txt (modified) (3 diffs)

waeup/branches/ulif-rewrite/src/waeup/app.txt

@@ -1 @@
-waeup.app
-*********
-
-Base components for a WAeUP portal.
+:mod:`waeup.app` -- central components for a WAeUP portal
+*********************************************************
 
 :Test-Layer: unit
 
-The main WAeUP application object is given with `University`. It
-provides the main containers as faculties, hostels, etc.
+.. module:: waeup.app
+
+.. class:: University
+
+  The main WAeUP application object is given with
+  :class:`University`. It provides the main containers as faculties,
+  hostels, etc.
+
+  .. attribute:: name
+
+     A string. The name of a university.
+
+  .. attribute:: faculties
+
+     An arbitrary object containing "faculties". In the case of
+     `University` it is a container of type
+     `waeup.interfaces.IFacultyContainer`.
+
 
 Creating `University` instances
 ===============================
 
-As `University` instances make use of the Zope Component Architecture
-(ZCA), we have to setup the basic component registries, before we can
-create instances. We do this by simply grokking the whole `waeup`
-package. This way all interfaces, utilities and adapters defined in
-the package are looked up and registered with the global registries::
+As :class:`University` instances make use of the Zope Component
+Architecture (ZCA), we have to setup the basic component registries,
+before we can create instances. We do this by simply grokking the
+whole :mod:`waeup` package. This way all interfaces, utilities and adapters
+defined in the package are looked up and registered with the global
+registries:
 
     >>> import grok
     >>> grok.testing.grok('waeup')
 
-Now we can import the `University` class and create an instence::
+Now we can import the :class:`University` class and create an
+instance:
 
     >>> from waeup.app import University
@@ -29 +45 @@
 
 Instances of `University` comply with the interface
-`waeup.interfaces.IUniversity`::
+`waeup.interfaces.IUniversity`:
 
     >>> from zope.interface.verify import verifyClass
@@ -36 +52 @@
     True
 
-University attributes
-=====================
-
-Instances of University provide some attributes as described in the
-`IUniversity` interface:
-
-``name``
-   A string. The name of a university.
-
-``faculties``
-   An arbitrary object containing "faculties". In the case of
-   `University` it is a container of type
-   `waeup.interfaces.IFacultyContainer`.
-
-A freshly created instance provides these attributes::
+A freshly created instance provides the attributes promised by the
+interface:
 
     >>> from waeup.app import University