Ignore:
Timestamp:
9 Mar 2012, 07:27:06 (13 years ago)
Author:
Henrik Bettermann
Message:

Update docs.

Location:
main/waeup.custom/trunk/docs/source
Files:
1 deleted
11 edited

Legend:

Unmodified
Added
Removed

  • main/waeup.custom/trunk/docs/source/bugs.rst

    r5339 r7823  
    11.. _reporting-bugs:
    22
    3 Reporting Bugs in `waeup.sirp`
     3Reporting Bugs in `waeup.kofa`
    44******************************
    55
    66The developers would like to know of any deficiencies you find in
    7 `waeup.sirp`.
     7`waeup.kofa`.
    88
    99Also telling about errors and shortcomings in the documentation are

  • main/waeup.custom/trunk/docs/source/conf.py

    r5662 r7823  
    11# -*- coding: utf-8 -*-
    22#
    3 # WAeUP Student Information and Registration Portal (SIRP) documentation build configuration file, created by
     3# WAeUP Student Information and Registration Portal (Kofa) documentation build configuration file, created by
    44# sphinx-quickstart on Thu Jul 29 10:41:59 2010.
    55#
    … …  
    4848
    4949# General information about the project.
    50 project = u'WAeUP SIRP'
     50project = u'WAeUP Kofa'
    5151copyright = u'2011, WAeUP Team'
    5252
    … …  
    5656#
    5757# The short X.Y version.
    58 version = pkg_resources.get_distribution('waeup.sirp').version
     58version = pkg_resources.get_distribution('waeup.kofa').version
    5959#version = '0.2dev'
    6060# The full version, including alpha/beta/rc tags.
    … …  
    174174
    175175# Output file base name for HTML help builder.
    176 htmlhelp_basename = 'WAeUPStudentInformationandRegistrationPortalSIRPdoc'
     176htmlhelp_basename = 'WAeUPStudentInformationandRegistrationPortalKofadoc'
    177177
    178178
    … …  
    188188# (source start file, target name, title, author, documentclass [howto/manual]).
    189189latex_documents = [
    190   ('index', 'WAeUPStudentInformationandRegistrationPortalSIRP.tex', u'WAeUP Student Information and Registration Portal (SIRP) Documentation',
     190  ('index', 'WAeUPStudentInformationandRegistrationPortalKofa.tex', u'WAeUP Student Information and Registration Portal (Kofa) Documentation',
    191191   u'WAeUP Team', 'manual'),
    192192]

  • main/waeup.custom/trunk/docs/source/contents.rst

    r5339 r7823  
    11.. _contents:
    22
    3 `waeup.sirp` documentation contents
     3`waeup.kofa` documentation contents
    44===================================
    55

  • main/waeup.custom/trunk/docs/source/copyright.rst

    r5338 r7823  
    22*********
    33
    4 `waeup.sirp` and this documentation is:
     4`waeup.kofa` and this documentation is:
    55
    66Copyright © 2009-2010 The WAeUP Group. All rights reserved.

  • main/waeup.custom/trunk/docs/source/developerdocs/developernotes.rst

    r6489 r7823  
    22***************
    33
    4 How to setup a developer instance of the WAeUP SIRP, handle tests, docs
     4How to setup a developer instance of the WAeUP Kofa, handle tests, docs
    55etc.
    66
    7 The new WAeUP SIRP is based on `Grok <http://grok.zope.org/>`_.
     7The new WAeUP Kofa is based on `Grok <http://grok.zope.org/>`_.
    88
    99Installing a developer copy
    … …  
    1515--------------------
    1616
    17 To create a working copy of the WAeUP SIRP we recommend use of
     17To create a working copy of the WAeUP Kofa we recommend use of
    1818`virtualenv`. You, however, need also some basic libraries, a C
    1919compiler and some things more.
    … …  
    127127In the sandbox (or anywhere else) we now create our real working
    128128environment. To do this, we change to the sandbox and checkout the
    129 sources of the WAeUP SIRP from the subversion server::
     129sources of the WAeUP Kofa from the subversion server::
    130130
    131131  $ cd mysandbox/
    132   $ svn co https://svn.waeup.org/repos/main/waeup.sirp/trunk waeup-trunk
     132  $ svn co https://svn.waeup.org/repos/main/waeup.kofa/trunk waeup-trunk
    133133
    134134where ``waeup-trunk`` is only a name we've chosen here to make clear
    … …  
    194194=============
    195195
    196 With the :mod:`waeup.sirp` package we try to reach high standards in
     196With the :mod:`waeup.kofa` package we try to reach high standards in
    197197both, documentation and testing.
    198198
    199 :mod:`waeup.sirp` makes extensive use of doctests, which this way also
     199:mod:`waeup.kofa` makes extensive use of doctests, which this way also
    200200become both: executable (i.e. testable) examples and documentation.
    201201
    … …  
    206206documentation generator to generate the docs as HTML pages.
    207207
    208 The documentation of the :mod:`waeup.sirp` project can easily be
     208The documentation of the :mod:`waeup.kofa` project can easily be
    209209created doing::
    210210
    … …  
    212212
    213213This will create a tree of HTML pages in
    214 ``parts/waeupdocs/waeup.sirp/build/waeup.sirp/`` which you can for
     214``parts/waeupdocs/waeup.kofa/build/waeup.kofa/`` which you can for
    215215instance browse by pointing your browser to this location.
    216216
    … …  
    223223
    224224means 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`
     225at the same time. See the many .txt files in the :mod:`waeup.kofa`
    226226package for examples.
    227227
    … …  
    230230=======
    231231
    232 Tests are most important to the reliability of the :mod:`waeup.sirp`
     232Tests are most important to the reliability of the :mod:`waeup.kofa`
    233233package. We don't tell someone that our code works, if we cannot prove
    234234it. And we prove it by testing.
    … …  
    246246  $ bin/test -c
    247247
    248 We have many tests in the :mod:`waeup.sirp` package so that sometimes
     248We have many tests in the :mod:`waeup.kofa` package so that sometimes
    249249you only want the functional *or* the unit tests to run. This can be
    250250done like this::
    … …  
    277277
    278278  Most unit tests furthermore declare that they want to be run inside
    279   the `WAeUPSIRPUnitTestLayer` defined in `waeup.sirp.testing`. This
    280   layer groks the whole `waeup.sirp` package, so that all ZCA
     279  the `WAeUPKofaUnitTestLayer` defined in `waeup.kofa.testing`. This
     280  layer groks the whole `waeup.kofa` package, so that all ZCA
    281281  components are already setup when you start your tests.
    282282 
    … …  
    284284  layer, the testfile has to provide the following line::
    285285
    286     .. :layer: waeup.sirp.testing.WAeUPSIRPUnitTestLayer
     286    .. :layer: waeup.kofa.testing.WAeUPKofaUnitTestLayer
    287287
    288288  Use it, if in your tests you make use of registered components like

  • main/waeup.custom/trunk/docs/source/developerdocs/index.rst

    r6488 r7823  
    77   developernotes
    88   api/index
    9    german/index

  • main/waeup.custom/trunk/docs/source/documentation.rst

    r5340 r7823  
    2222
    2323See :ref:`reporting-bugs` for information how to report bugs in
    24 `waeup.sirp` itself.
     24`waeup.kofa` itself.
    2525
    2626.. _Sphinx: http://sphinx.org/

  • main/waeup.custom/trunk/docs/source/glossary.rst

    r5338 r7823  
    66.. glossary::
    77
    8    SIRP
     8   Kofa
    99     Student Information and Registration Portal.
    1010
    … …  
    1212     West African e-University Project.
    1313
    14    waeup.sirp
     14   waeup.kofa
    1515     A Python package explained in this documentation.
    1616

  • main/waeup.custom/trunk/docs/source/index.rst

    r5338 r7823  
    1 .. WAeUP Student Information and Registration Portal (SIRP) documentation master file, created by
     1.. WAeUP Student Information and Registration Portal (Kofa) documentation master file, created by
    22   sphinx-quickstart on Thu Jul 29 10:41:59 2010.
    33   You can adapt this file completely to your liking, but it should at least

  • main/waeup.custom/trunk/docs/source/license.rst

    r5338 r7823  
    55***********
    66
    7 `waeup.sirp` is covered by the following license. If that license
     7`waeup.kofa` is covered by the following license. If that license
    88does not fit your needs and you need a copy of the software licensed
    99differently, please contact ``henrik <at> waeup <dot> org``.

  • main/waeup.custom/trunk/docs/source/userdocs/buildingdocs.rst

    r6619 r7823  
    44**************************************
    55
    6 To build the documentation for :mod:`waeup.sirp`, please follow these steps:
     6To build the documentation for :mod:`waeup.kofa`, please follow these steps:
    77
    88Prerequisites
    99=============
    1010
    11 We assume you already installed `waeup.sirp` as explained in
     11We assume you already installed `waeup.kofa` as explained in
    1212:ref:`installing_linux`. You ran ``bin/buildout`` and can find a script
    1313``bin/waeupdocs``.
    … …  
    1616==================
    1717
    18 After successful install go to the root dir, where `waeup.sirp` is
     18After successful install go to the root dir, where `waeup.kofa` is
    1919located.
    2020
Note: See TracChangeset for help on using the changeset viewer.