Changeset 7808 for main/waeup.kofa/trunk/docs/source
- Timestamp:
- 8 Mar 2012, 17:58:57 (13 years ago)
- Location:
- main/waeup.kofa/trunk/docs/source
- Files:
-
- 103 edited
Legend:
- Unmodified
- Added
- Removed
-
main/waeup.kofa/trunk/docs/source/_templates/mainpage.template
r7666 r7808 5 5 <h1>{{ docstitle }}</h1> 6 6 <p> 7 This is official documentation for waeup. sirp{{ release }}.7 This is official documentation for waeup.kofa {{ release }}. 8 8 {% if last_updated %}Last modifed on {{ last_updated }}.{% endif %} 9 9 </p> … … 13 13 <td width="50%"> 14 14 <p class="biglink"> 15 <a class="biglink" 15 <a class="biglink" 16 16 href="{{ pathto("intro") }}">Introduction</a><br /> 17 <span class="linkdescr">Get started with waeup. sirp.</span>17 <span class="linkdescr">Get started with waeup.kofa.</span> 18 18 </p> 19 19 20 20 <p class="biglink"> 21 <a class="biglink" 21 <a class="biglink" 22 22 href="{{ pathto("userdocs/index") }}">User Documentation</a><br /> 23 23 <span class="linkdescr"> 24 Documentation for users and admins using waeup. sirp.24 Documentation for users and admins using waeup.kofa. 25 25 </span></p> 26 26 27 27 </td><td width="50%"> 28 28 <p class="biglink"> 29 <a class="biglink" 29 <a class="biglink" 30 30 href="{{ pathto("changes") }}">What's new?</a><br /> 31 31 <span class="linkdescr">Changes made in each release.</span> … … 33 33 34 34 <p class="biglink"> 35 <a class="biglink" 35 <a class="biglink" 36 36 href="{{ pathto("developerdocs/index") }}">Developer Documentation</a><br /> 37 37 <span class="linkdescr"> … … 40 40 </span> 41 41 </p> 42 42 43 43 </td></tr> 44 44 </table> … … 48 48 <td width="50%"> 49 49 <p class="biglink"> 50 <a class="biglink" 50 <a class="biglink" 51 51 href="{{ pathto("contents") }}">Table of Contents</a><br /> 52 52 <span class="linkdescr">Lists all sections and subsections.</span> … … 55 55 56 56 <p class="biglink"> 57 <a class="biglink" 57 <a class="biglink" 58 58 href="{{ pathto("genindex") }}">Index</a><br /> 59 59 <span class="linkdescr">All functions, classes, terms.</span> … … 67 67 68 68 <p class="biglink"> 69 <a class="biglink" 69 <a class="biglink" 70 70 href="{{ pathto("bugs") }}">Reporting Bugs</a><br /> 71 71 </p> 72 72 73 73 <p class="biglink"> 74 <a class="biglink" 74 <a class="biglink" 75 75 href="{{ pathto("documentation") }}">About the Documentation</a><br /> 76 76 </p> 77 77 78 78 </td><td width="50%"> 79 79 80 80 <p class="biglink"> 81 <a class="biglink" 81 <a class="biglink" 82 82 href="{{ pathto("license") }}">License</a><br /> 83 83 </p> 84 84 85 85 <p class="biglink"> 86 <a class="biglink" 86 <a class="biglink" 87 87 href="{{ pathto("copyright") }}">Copyright</a><br /> 88 88 </p> -
main/waeup.kofa/trunk/docs/source/bugs.rst
r5339 r7808 1 1 .. _reporting-bugs: 2 2 3 Reporting Bugs in `waeup. sirp`3 Reporting Bugs in `waeup.kofa` 4 4 ****************************** 5 5 6 6 The developers would like to know of any deficiencies you find in 7 `waeup. sirp`.7 `waeup.kofa`. 8 8 9 9 Also telling about errors and shortcomings in the documentation are -
main/waeup.kofa/trunk/docs/source/conf.py
r7666 r7808 1 1 # -*- coding: utf-8 -*- 2 2 # 3 # WAeUP Student Information and Registration Portal ( SIRP) documentation build configuration file, created by3 # WAeUP Student Information and Registration Portal (KOFA) documentation build configuration file, created by 4 4 # sphinx-quickstart on Thu Jul 29 10:41:59 2010. 5 5 # … … 48 48 49 49 # General information about the project. 50 project = u'WAeUP. SIRP'50 project = u'WAeUP.KOFA' 51 51 copyright = u'2011, WAeUP Team' 52 52 … … 56 56 # 57 57 # The short X.Y version. 58 version = pkg_resources.get_distribution('waeup. sirp').version58 version = pkg_resources.get_distribution('waeup.kofa').version 59 59 #version = '0.2dev' 60 60 # The full version, including alpha/beta/rc tags. … … 174 174 175 175 # Output file base name for HTML help builder. 176 htmlhelp_basename = 'WAeUPStudentInformationandRegistrationPortal SIRPdoc'176 htmlhelp_basename = 'WAeUPStudentInformationandRegistrationPortalKOFAdoc' 177 177 178 178 … … 188 188 # (source start file, target name, title, author, documentclass [howto/manual]). 189 189 latex_documents = [ 190 ('index', 'WAeUPStudentInformationandRegistrationPortal SIRP.tex', u'WAeUP Student Information and Registration Portal (SIRP) Documentation',190 ('index', 'WAeUPStudentInformationandRegistrationPortalKOFA.tex', u'WAeUP Student Information and Registration Portal (KOFA) Documentation', 191 191 u'WAeUP Team', 'manual'), 192 192 ] -
main/waeup.kofa/trunk/docs/source/contents.rst
r7666 r7808 1 1 .. _contents: 2 2 3 WAeUP. SIRPDocumentation Contents3 WAeUP.KOFA Documentation Contents 4 4 ================================= 5 5 -
main/waeup.kofa/trunk/docs/source/copyright.rst
r5338 r7808 2 2 ********* 3 3 4 `waeup. sirp` and this documentation is:4 `waeup.kofa` and this documentation is: 5 5 6 6 Copyright © 2009-2010 The WAeUP Group. All rights reserved. -
main/waeup.kofa/trunk/docs/source/developerdocs/api/accesscodes/api_accesscode.rst
r6756 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.accesscodes.accesscode4 .. automodule:: waeup.kofa.accesscodes.accesscode 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/accesscodes/api_browser.rst
r6756 r7808 8 8 9 9 .. 10 .. automodule:: waeup. sirp.accesscodes.browser10 .. automodule:: waeup.kofa.accesscodes.browser 11 11 :members: 12 12 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/accesscodes/api_catalog.rst
r6756 r7808 2 2 ********************************************** 3 3 4 .. automodule:: waeup. sirp.accesscodes.catalog4 .. automodule:: waeup.kofa.accesscodes.catalog 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/accesscodes/api_interfaces.rst
r6756 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.accesscodes.interfaces4 .. automodule:: waeup.kofa.accesscodes.interfaces 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/accesscodes/api_workflow.rst
r6756 r7808 2 2 *********************************************** 3 3 4 .. automodule:: waeup. sirp.accesscodes.workflow4 .. automodule:: waeup.kofa.accesscodes.workflow 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_accesscodes.rst
r6634 r7808 4 4 (see also: :ref:`api-accesscodes-modules`) 5 5 6 .. automodule:: waeup. sirp.accesscodes6 .. automodule:: waeup.kofa.accesscodes 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_app.rst
r6505 r7808 2 2 ************************************** 3 3 4 .. automodule:: waeup. sirp.app4 .. automodule:: waeup.kofa.app 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_applicants.rst
r6756 r7808 4 4 (see also: :ref:`api-applicants-modules`) 5 5 6 .. automodule:: waeup. sirp.applicants6 .. automodule:: waeup.kofa.applicants 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_authentication.rst
r6505 r7808 2 2 **************************************************** 3 3 4 .. automodule:: waeup. sirp.authentication4 .. automodule:: waeup.kofa.authentication 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_browser.rst
r6516 r7808 4 4 (see also: :ref:`api-browser-modules`) 5 5 6 .. automodule:: waeup. sirp.browser6 .. automodule:: waeup.kofa.browser 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_catalog.rst
r6505 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.catalog4 .. automodule:: waeup.kofa.catalog 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_datacenter.rst
r6505 r7808 2 2 ********************************* 3 3 4 .. automodule:: waeup. sirp.datacenter4 .. automodule:: waeup.kofa.datacenter 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_hostels.rst
r7594 r7808 4 4 (see also: :ref:`api-accommodation-modules`) 5 5 6 .. automodule:: waeup. sirp.hostels6 .. automodule:: waeup.kofa.hostels 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_imagestorage.rst
r7063 r7808 2 2 ************************************************ 3 3 4 .. automodule:: waeup. sirp.imagestorage4 .. automodule:: waeup.kofa.imagestorage 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_interfaces.rst
r6505 r7808 2 2 ************************************* 3 3 4 .. automodule:: waeup. sirp.interfaces4 .. automodule:: waeup.kofa.interfaces 5 5 :members: 6 6 :undoc-members: 7 7 8 .. autointerface:: waeup. sirp.interfaces.IUniversity8 .. autointerface:: waeup.kofa.interfaces.IUniversity 9 9 :members: 10 10 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_payments.rst
r7595 r7808 4 4 (see also: :ref:`api-payments-modules`) 5 5 6 .. automodule:: waeup. sirp.payments6 .. automodule:: waeup.kofa.payments 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_permissions.rst
r6505 r7808 2 2 ******************************************************** 3 3 4 .. automodule:: waeup. sirp.permissions4 .. automodule:: waeup.kofa.permissions 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_schema.rst
r7598 r7808 4 4 (see also: :ref:`api-schema-modules`) 5 5 6 .. automodule:: waeup. sirp.utils6 .. automodule:: waeup.kofa.utils 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_students.rst
r7594 r7808 4 4 (see also: :ref:`api-students-modules`) 5 5 6 .. automodule:: waeup. sirp.students6 .. automodule:: waeup.kofa.students 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_university.rst
r7589 r7808 4 4 (see also: :ref:`api-university-modules`) 5 5 6 .. automodule:: waeup. sirp.university6 .. automodule:: waeup.kofa.university 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_userscontainer.rst
r7589 r7808 2 2 ********************************************* 3 3 4 .. automodule:: waeup. sirp.userscontainer4 .. automodule:: waeup.kofa.userscontainer 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_utils.rst
r7596 r7808 4 4 (see also: :ref:`api-utils-modules`) 5 5 6 .. automodule:: waeup. sirp.utils6 .. automodule:: waeup.kofa.utils 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_widgets.rst
r7598 r7808 4 4 (see also: :ref:`api-widgets-modules`) 5 5 6 .. automodule:: waeup. sirp.widgets6 .. automodule:: waeup.kofa.widgets 7 7 :members: 8 8 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/api_workflow.rst
r6505 r7808 2 2 **************************************** 3 3 4 .. automodule:: waeup. sirp.workflow4 .. automodule:: waeup.kofa.workflow 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_applicant.rst
r6634 r7808 2 2 ********************************************* 3 3 4 .. automodule:: waeup. sirp.applicants.applicant4 .. automodule:: waeup.kofa.applicants.applicant 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_authentication.rst
r6596 r7808 2 2 ****************************************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.authentication4 .. automodule:: waeup.kofa.applicants.authentication 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_batching.rst
r6596 r7808 2 2 ***************************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.batching4 .. automodule:: waeup.kofa.applicants.batching 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_browser.rst
r7063 r7808 2 2 *********************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.browser4 .. automodule:: waeup.kofa.applicants.browser 5 5 :members: 6 6 -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_container.rst
r6505 r7808 2 2 ************************************************* 3 3 4 .. automodule:: waeup. sirp.applicants.container4 .. automodule:: waeup.kofa.applicants.container 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_interfaces.rst
r7589 r7808 2 2 ******************************************************* 3 3 4 .. automodule:: waeup. sirp.applicants.interfaces4 .. automodule:: waeup.kofa.applicants.interfaces 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_permissions.rst
r6596 r7808 2 2 *********************************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.permissions4 .. automodule:: waeup.kofa.applicants.permissions 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_root.rst
r6505 r7808 2 2 ************************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.root4 .. automodule:: waeup.kofa.applicants.root 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_vocabularies.rst
r6596 r7808 2 2 **************************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.vocabularies4 .. automodule:: waeup.kofa.applicants.vocabularies 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/applicants/api_workflow.rst
r6596 r7808 2 2 ****************************************************** 3 3 4 .. automodule:: waeup. sirp.applicants.workflow4 .. automodule:: waeup.kofa.applicants.workflow 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_breadcrumbs.rst
r6516 r7808 2 2 ******************************************* 3 3 4 .. automodule:: waeup. sirp.browser.breadcrumbs4 .. automodule:: waeup.kofa.browser.breadcrumbs 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_exceptions.rst
r6516 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.browser.exceptions4 .. automodule:: waeup.kofa.browser.exceptions 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_interfaces.rst
r6516 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.browser.interfaces4 .. automodule:: waeup.kofa.browser.interfaces 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_layout.rst
r6516 r7808 2 2 ********************************* 3 3 4 .. automodule:: waeup. sirp.browser.layout4 .. automodule:: waeup.kofa.browser.layout 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_pages.rst
r6506 r7808 2 2 *************************************** 3 3 4 .. automodule:: waeup. sirp.browser.pages4 .. automodule:: waeup.kofa.browser.pages 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_resources.rst
r6516 r7808 2 2 *************************************** 3 3 4 .. automodule:: waeup. sirp.browser.resources4 .. automodule:: waeup.kofa.browser.resources 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_theming.rst
r6516 r7808 2 2 *********************************** 3 3 4 .. automodule:: waeup. sirp.browser.theming4 .. automodule:: waeup.kofa.browser.theming 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/browser/api_viewlets.rst
r6517 r7808 7 7 8 8 .. 9 .. automodule:: waeup. sirp.browser.viewlets9 .. automodule:: waeup.kofa.browser.viewlets 10 10 :members: 11 11 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_browser.rst
r7594 r7808 7 7 8 8 .. 9 .. automodule:: waeup. sirp.hostels.browser9 .. automodule:: waeup.kofa.hostels.browser 10 10 :members: 11 11 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_catalog.rst
r7594 r7808 2 2 ********************************** 3 3 4 .. automodule:: waeup. sirp.hostels.catalog4 .. automodule:: waeup.kofa.hostels.catalog 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_container.rst
r7594 r7808 2 2 ************************************************** 3 3 4 .. automodule:: waeup. sirp.hostels.container4 .. automodule:: waeup.kofa.hostels.container 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_hostel.rst
r7594 r7808 2 2 ************************************ 3 3 4 .. automodule:: waeup. sirp.hostels.hostel4 .. automodule:: waeup.kofa.hostels.hostel 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_interfaces.rst
r7594 r7808 2 2 ************************************************ 3 3 4 .. automodule:: waeup. sirp.hostels.interfaces4 .. automodule:: waeup.kofa.hostels.interfaces 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_permissions.rst
r7594 r7808 2 2 ****************************************** 3 3 4 .. automodule:: waeup. sirp.hostels.permissions4 .. automodule:: waeup.kofa.hostels.permissions 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/hostels/api_vocabularies.rst
r7594 r7808 2 2 ******************************************** 3 3 4 .. automodule:: waeup. sirp.hostels.vocabularies4 .. automodule:: waeup.kofa.hostels.vocabularies 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/index.rst
r7598 r7808 2 2 *** 3 3 4 .. automodule:: waeup. sirp4 .. automodule:: waeup.kofa 5 5 :members: 6 6 … … 8 8 -------------------- 9 9 10 `waeup. sirp` provides the following modules and subpackages:10 `waeup.kofa` provides the following modules and subpackages: 11 11 12 12 .. toctree:: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/payments/api_container.rst
r7595 r7808 2 2 **************************************************** 3 3 4 .. automodule:: waeup. sirp.payments.container4 .. automodule:: waeup.kofa.payments.container 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/payments/api_interfaces.rst
r7595 r7808 2 2 ****************************************** 3 3 4 .. automodule:: waeup. sirp.payments.interfaces4 .. automodule:: waeup.kofa.payments.interfaces 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/payments/api_payment.rst
r7595 r7808 2 2 *************************************** 3 3 4 .. automodule:: waeup. sirp.payments.payment4 .. automodule:: waeup.kofa.payments.payment 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/payments/api_vocabularies.rst
r7595 r7808 2 2 ********************************************** 3 3 4 .. automodule:: waeup. sirp.payments.vocabularies4 .. automodule:: waeup.kofa.payments.vocabularies 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/schema/api_field.rst
r7598 r7808 2 2 ******************************* 3 3 4 .. automodule:: waeup. sirp.schema.field4 .. automodule:: waeup.kofa.schema.field 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_accommodation.rst
r7593 r7808 2 2 *********************************************************** 3 3 4 .. automodule:: waeup. sirp.students.accommodation4 .. automodule:: waeup.kofa.students.accommodation 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_authentication.rst
r7593 r7808 2 2 ************************************************************* 3 3 4 .. automodule:: waeup. sirp.students.authentication4 .. automodule:: waeup.kofa.students.authentication 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_batching.rst
r7593 r7808 2 2 ********************************************************** 3 3 4 .. automodule:: waeup. sirp.students.batching4 .. automodule:: waeup.kofa.students.batching 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_browser.rst
r7593 r7808 2 2 ******************************************* 3 3 4 .. automodule:: waeup. sirp.students.browser4 .. automodule:: waeup.kofa.students.browser 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_catalog.rst
r7593 r7808 2 2 ************************************************ 3 3 4 .. automodule:: waeup. sirp.students.catalog4 .. automodule:: waeup.kofa.students.catalog 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_container.rst
r7593 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.students.container4 .. automodule:: waeup.kofa.students.container 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_dynamicroles.rst
r7593 r7808 2 2 ************************************************** 3 3 4 .. automodule:: waeup. sirp.students.dynamicroles4 .. automodule:: waeup.kofa.students.dynamicroles 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_interfaces.rst
r7593 r7808 2 2 *************************************************** 3 3 4 .. automodule:: waeup. sirp.students.interfaces4 .. automodule:: waeup.kofa.students.interfaces 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_payments.rst
r7593 r7808 2 2 ************************************** 3 3 4 .. automodule:: waeup. sirp.students.payments4 .. automodule:: waeup.kofa.students.payments 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_permissions.rst
r7593 r7808 2 2 ******************************************** 3 3 4 .. automodule:: waeup. sirp.students.permissions4 .. automodule:: waeup.kofa.students.permissions 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_student.rst
r7593 r7808 2 2 *************************************** 3 3 4 .. automodule:: waeup. sirp.students.student4 .. automodule:: waeup.kofa.students.student 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_studycourse.rst
r7593 r7808 2 2 ******************************************************** 3 3 4 .. automodule:: waeup. sirp.students.studycourse4 .. automodule:: waeup.kofa.students.studycourse 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_studylevel.rst
r7593 r7808 2 2 ****************************************************** 3 3 4 .. automodule:: waeup. sirp.students.studylevel4 .. automodule:: waeup.kofa.students.studylevel 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_utils.rst
r7593 r7808 2 2 ************************************ 3 3 4 .. automodule:: waeup. sirp.students.utils4 .. automodule:: waeup.kofa.students.utils 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_viewlets.rst
r7593 r7808 7 7 8 8 .. 9 .. automodule:: waeup. sirp.students.viewlets9 .. automodule:: waeup.kofa.students.viewlets 10 10 :members: 11 11 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_vocabularies.rst
r7593 r7808 2 2 ********************************************** 3 3 4 .. automodule:: waeup. sirp.students.vocabularies4 .. automodule:: waeup.kofa.students.vocabularies 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/students/api_workflow.rst
r7593 r7808 2 2 ************************************** 3 3 4 .. automodule:: waeup. sirp.students.workflow4 .. automodule:: waeup.kofa.students.workflow 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_batching.rst
r6506 r7808 2 2 ******************************************* 3 3 4 .. automodule:: waeup. sirp.university.batching4 .. automodule:: waeup.kofa.university.batching 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_catalog.rst
r6506 r7808 2 2 ******************************************** 3 3 4 .. automodule:: waeup. sirp.university.catalog4 .. automodule:: waeup.kofa.university.catalog 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_certificate.rst
r6506 r7808 2 2 ************************************************* 3 3 4 .. automodule:: waeup. sirp.university.certificate4 .. automodule:: waeup.kofa.university.certificate 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_certificatescontainer.rst
r7589 r7808 2 2 ********************************************************************** 3 3 4 .. automodule:: waeup. sirp.university.certificatescontainer4 .. automodule:: waeup.kofa.university.certificatescontainer 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_course.rst
r6506 r7808 2 2 *************************************** 3 3 4 .. automodule:: waeup. sirp.university.course4 .. automodule:: waeup.kofa.university.course 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_coursescontainer.rst
r7589 r7808 2 2 ************************************************************ 3 3 4 .. automodule:: waeup. sirp.university.coursescontainer4 .. automodule:: waeup.kofa.university.coursescontainer 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_department.rst
r6506 r7808 2 2 *********************************************** 3 3 4 .. automodule:: waeup. sirp.university.department4 .. automodule:: waeup.kofa.university.department 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_facultiescontainer.rst
r7589 r7808 2 2 **************************************************************** 3 3 4 .. automodule:: waeup. sirp.university.facultiescontainer4 .. automodule:: waeup.kofa.university.facultiescontainer 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_faculty.rst
r6506 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.university.faculty4 .. automodule:: waeup.kofa.university.faculty 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_interfaces.rst
r7589 r7808 2 2 ************************************************************** 3 3 4 .. automodule:: waeup. sirp.university.interfaces4 .. automodule:: waeup.kofa.university.interfaces 5 5 :members: 6 6 :undoc-members: 7 7 8 .. autointerface:: waeup. sirp.university.interfaces.IFaculty8 .. autointerface:: waeup.kofa.university.interfaces.IFaculty 9 9 :members: 10 10 11 .. autointerface:: waeup. sirp.university.interfaces.IFacultyAdd11 .. autointerface:: waeup.kofa.university.interfaces.IFacultyAdd 12 12 :members: 13 13 14 .. autointerface:: waeup. sirp.university.interfaces.IFacultiesContainer14 .. autointerface:: waeup.kofa.university.interfaces.IFacultiesContainer 15 15 :members: 16 16 17 .. autointerface:: waeup. sirp.university.interfaces.IDepartment17 .. autointerface:: waeup.kofa.university.interfaces.IDepartment 18 18 :members: 19 19 20 .. autointerface:: waeup. sirp.university.interfaces.IDepartmentAdd20 .. autointerface:: waeup.kofa.university.interfaces.IDepartmentAdd 21 21 :members: 22 22 23 .. autointerface:: waeup. sirp.university.interfaces.ICoursesContainer23 .. autointerface:: waeup.kofa.university.interfaces.ICoursesContainer 24 24 :members: 25 25 26 .. autointerface:: waeup. sirp.university.interfaces.ICourse26 .. autointerface:: waeup.kofa.university.interfaces.ICourse 27 27 :members: 28 28 29 .. autointerface:: waeup. sirp.university.interfaces.ICourseAdd29 .. autointerface:: waeup.kofa.university.interfaces.ICourseAdd 30 30 :members: 31 31 32 .. autointerface:: waeup. sirp.university.interfaces.ICertificate32 .. autointerface:: waeup.kofa.university.interfaces.ICertificate 33 33 :members: 34 34 35 .. autointerface:: waeup. sirp.university.interfaces.ICertificateAdd35 .. autointerface:: waeup.kofa.university.interfaces.ICertificateAdd 36 36 :members: 37 37 38 .. autointerface:: waeup. sirp.university.interfaces.ICertificatesContainer38 .. autointerface:: waeup.kofa.university.interfaces.ICertificatesContainer 39 39 :members: 40 40 41 .. autointerface:: waeup. sirp.university.interfaces.ICertificateCourse41 .. autointerface:: waeup.kofa.university.interfaces.ICertificateCourse 42 42 :members: 43 43 44 .. autointerface:: waeup. sirp.university.interfaces.ICertificateCourseAdd44 .. autointerface:: waeup.kofa.university.interfaces.ICertificateCourseAdd 45 45 :members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/university/api_vocabularies.rst
r6506 r7808 2 2 **************************************************** 3 3 4 .. automodule:: waeup. sirp.university.vocabularies4 .. automodule:: waeup.kofa.university.vocabularies 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/utils/api_batching.rst
r7596 r7808 2 2 ************************************** 3 3 4 .. automodule:: waeup. sirp.utils.batching4 .. automodule:: waeup.kofa.utils.batching 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/utils/api_converters.rst
r7596 r7808 2 2 ***************************************** 3 3 4 .. automodule:: waeup. sirp.utils.converters4 .. automodule:: waeup.kofa.utils.converters 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/utils/api_helpers.rst
r7596 r7808 2 2 *********************************** 3 3 4 .. automodule:: waeup. sirp.utils.helpers4 .. automodule:: waeup.kofa.utils.helpers 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/utils/api_logger.rst
r7596 r7808 2 2 ********************************** 3 3 4 .. automodule:: waeup. sirp.utils.logger4 .. automodule:: waeup.kofa.utils.logger 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/utils/api_utils.rst
r7596 r7808 2 2 ************************* 3 3 4 .. automodule:: waeup. sirp.utils.utils4 .. automodule:: waeup.kofa.utils.utils 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/widgets/api_datewidget.rst
r7598 r7808 2 2 ********************************** 3 3 4 .. automodule:: waeup. sirp.widgets.datewidget4 .. automodule:: waeup.kofa.widgets.datewidget 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/widgets/api_objectwidget.rst
r7598 r7808 2 2 ************************************** 3 3 4 .. automodule:: waeup. sirp.widgets.objectwidget4 .. automodule:: waeup.kofa.widgets.objectwidget 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/widgets/api_phonewidget.rst
r7598 r7808 2 2 ************************************ 3 3 4 .. automodule:: waeup. sirp.widgets.phonewidget4 .. automodule:: waeup.kofa.widgets.phonewidget 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/api/widgets/api_restwidget.rst
r7598 r7808 2 2 ********************************** 3 3 4 .. automodule:: waeup. sirp.widgets.restwidget4 .. automodule:: waeup.kofa.widgets.restwidget 5 5 :members: 6 6 :undoc-members: -
main/waeup.kofa/trunk/docs/source/developerdocs/developernotes.rst
r7666 r7808 2 2 *************** 3 3 4 How to setup a developer instance of the WAeUP. SIRP, handle tests, docs4 How to setup a developer instance of the WAeUP.KOFA, handle tests, docs 5 5 etc. 6 6 7 The new WAeUP. SIRPis based on `Grok <http://grok.zope.org/>`_.7 The new WAeUP.KOFA is based on `Grok <http://grok.zope.org/>`_. 8 8 9 9 Installing a developer copy … … 15 15 -------------------- 16 16 17 To create a working copy of the WAeUP. SIRPwe recommend use of17 To create a working copy of the WAeUP.KOFA we recommend use of 18 18 `virtualenv`. You, however, need also some basic libraries, a C 19 19 compiler and some things more. … … 127 127 In the sandbox (or anywhere else) we now create our real working 128 128 environment. To do this, we change to the sandbox and checkout the 129 sources of the WAeUP. SIRPfrom the subversion server::129 sources of the WAeUP.KOFA from the subversion server:: 130 130 131 131 $ cd mysandbox/ 132 $ svn co https://svn.waeup.org/repos/main/waeup. sirp/trunk waeup-trunk132 $ svn co https://svn.waeup.org/repos/main/waeup.kofa/trunk waeup-trunk 133 133 134 134 where ``waeup-trunk`` is only a name we've chosen here to make clear … … 194 194 ============= 195 195 196 With the :mod:`waeup. sirp` package we try to reach high standards in196 With the :mod:`waeup.kofa` package we try to reach high standards in 197 197 both, documentation and testing. 198 198 199 :mod:`waeup. sirp` makes extensive use of doctests, which this way also199 :mod:`waeup.kofa` makes extensive use of doctests, which this way also 200 200 become both: executable (i.e. testable) examples and documentation. 201 201 … … 206 206 documentation generator to generate the docs as HTML pages. 207 207 208 The documentation of the :mod:`waeup. sirp` project can easily be208 The documentation of the :mod:`waeup.kofa` project can easily be 209 209 created doing:: 210 210 … … 212 212 213 213 This will create a tree of HTML pages in 214 ``parts/waeupdocs/waeup. sirp/build/waeup.sirp/`` which you can for214 ``parts/waeupdocs/waeup.kofa/build/waeup.kofa/`` which you can for 215 215 instance browse by pointing your browser to this location. 216 216 … … 223 223 224 224 means explaining to other developers what your code does and test it 225 at the same time. See the many .txt files in the :mod:`waeup. sirp`225 at the same time. See the many .txt files in the :mod:`waeup.kofa` 226 226 package for examples. 227 227 … … 230 230 ======= 231 231 232 Tests are most important to the reliability of the :mod:`waeup. sirp`232 Tests are most important to the reliability of the :mod:`waeup.kofa` 233 233 package. We don't tell someone that our code works, if we cannot prove 234 234 it. And we prove it by testing. … … 246 246 $ bin/test -c 247 247 248 We have many tests in the :mod:`waeup. sirp` package so that sometimes248 We have many tests in the :mod:`waeup.kofa` package so that sometimes 249 249 you only want the functional *or* the unit tests to run. This can be 250 250 done like this:: … … 277 277 278 278 Most unit tests furthermore declare that they want to be run inside 279 the `WAeUP SIRPUnitTestLayer` defined in `waeup.sirp.testing`. This280 layer groks the whole `waeup. sirp` package, so that all ZCA279 the `WAeUPKOFAUnitTestLayer` defined in `waeup.kofa.testing`. This 280 layer groks the whole `waeup.kofa` package, so that all ZCA 281 281 components are already setup when you start your tests. 282 282 … … 284 284 layer, the testfile has to provide the following line:: 285 285 286 .. :layer: waeup. sirp.testing.WAeUPSIRPUnitTestLayer286 .. :layer: waeup.kofa.testing.WAeUPKOFAUnitTestLayer 287 287 288 288 Use it, if in your tests you make use of registered components like -
main/waeup.kofa/trunk/docs/source/documentation.rst
r5340 r7808 22 22 23 23 See :ref:`reporting-bugs` for information how to report bugs in 24 `waeup. sirp` itself.24 `waeup.kofa` itself. 25 25 26 26 .. _Sphinx: http://sphinx.org/ -
main/waeup.kofa/trunk/docs/source/glossary.rst
r5338 r7808 6 6 .. glossary:: 7 7 8 SIRP8 KOFA 9 9 Student Information and Registration Portal. 10 10 … … 12 12 West African e-University Project. 13 13 14 waeup. sirp14 waeup.kofa 15 15 A Python package explained in this documentation. 16 16 -
main/waeup.kofa/trunk/docs/source/index.rst
r5338 r7808 1 .. WAeUP Student Information and Registration Portal ( SIRP) documentation master file, created by1 .. WAeUP Student Information and Registration Portal (KOFA) documentation master file, created by 2 2 sphinx-quickstart on Thu Jul 29 10:41:59 2010. 3 3 You can adapt this file completely to your liking, but it should at least -
main/waeup.kofa/trunk/docs/source/license.rst
r5338 r7808 5 5 *********** 6 6 7 `waeup. sirp` is covered by the following license. If that license7 `waeup.kofa` is covered by the following license. If that license 8 8 does not fit your needs and you need a copy of the software licensed 9 9 differently, please contact ``henrik <at> waeup <dot> org``. -
main/waeup.kofa/trunk/docs/source/userdocs/buildingdocs.rst
r6619 r7808 4 4 ************************************** 5 5 6 To build the documentation for :mod:`waeup. sirp`, please follow these steps:6 To build the documentation for :mod:`waeup.kofa`, please follow these steps: 7 7 8 8 Prerequisites 9 9 ============= 10 10 11 We assume you already installed `waeup. sirp` as explained in11 We assume you already installed `waeup.kofa` as explained in 12 12 :ref:`installing_linux`. You ran ``bin/buildout`` and can find a script 13 13 ``bin/waeupdocs``. … … 16 16 ================== 17 17 18 After successful install go to the root dir, where `waeup. sirp` is18 After successful install go to the root dir, where `waeup.kofa` is 19 19 located. 20 20
Note: See TracChangeset for help on using the changeset viewer.