Changeset 7823 for main/waeup.custom/trunk/docs/source/developerdocs

Timestamp:

9 Mar 2012, 07:27:06 (13 years ago)

Author:

Henrik Bettermann

Message:

Update docs.

Location:

main/waeup.custom/trunk/docs/source/developerdocs

Files:

• developernotes.rst (modified) (11 diffs)
• german (deleted)
• index.rst (modified) (1 diff)

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

@@ -2 +2 @@
 ***************
 
-How to setup a developer instance of the WAeUP SIRP, handle tests, docs
+How to setup a developer instance of the WAeUP Kofa, handle tests, docs
 etc.
 
-The new WAeUP SIRP is based on `Grok <http://grok.zope.org/>`_.
+The new WAeUP Kofa is based on `Grok <http://grok.zope.org/>`_.
 
 Installing a developer copy
@@ -15 +15 @@
 --------------------
 
-To create a working copy of the WAeUP SIRP we recommend use of
+To create a working copy of the WAeUP Kofa we recommend use of
 `virtualenv`. You, however, need also some basic libraries, a C
 compiler and some things more.
@@ -127 +127 @@
 In the sandbox (or anywhere else) we now create our real working
 environment. To do this, we change to the sandbox and checkout the
-sources of the WAeUP SIRP from the subversion server::
+sources of the WAeUP Kofa from the subversion server::
 
   $ cd mysandbox/
-  $ svn co https://svn.waeup.org/repos/main/waeup.sirp/trunk waeup-trunk
+  $ svn co https://svn.waeup.org/repos/main/waeup.kofa/trunk waeup-trunk
 
 where ``waeup-trunk`` is only a name we've chosen here to make clear
@@ -194 +194 @@
 =============
 
-With the :mod:`waeup.sirp` package we try to reach high standards in
+With the :mod:`waeup.kofa` package we try to reach high standards in
 both, documentation and testing.
 
-:mod:`waeup.sirp` makes extensive use of doctests, which this way also
+:mod:`waeup.kofa` makes extensive use of doctests, which this way also
 become both: executable (i.e. testable) examples and documentation.
 
@@ -206 +206 @@
 documentation generator to generate the docs as HTML pages.
 
-The documentation of the :mod:`waeup.sirp` project can easily be
+The documentation of the :mod:`waeup.kofa` project can easily be
 created doing::
 
@@ -212 +212 @@
 
 This will create a tree of HTML pages in
-``parts/waeupdocs/waeup.sirp/build/waeup.sirp/`` which you can for
+``parts/waeupdocs/waeup.kofa/build/waeup.kofa/`` which you can for
 instance browse by pointing your browser to this location.
 
@@ -223 +223 @@
 
 means explaining to other developers what your code does and test it
-at the same time. See the many .txt files in the :mod:`waeup.sirp`
+at the same time. See the many .txt files in the :mod:`waeup.kofa`
 package for examples.
 
@@ -230 +230 @@
 =======
 
-Tests are most important to the reliability of the :mod:`waeup.sirp`
+Tests are most important to the reliability of the :mod:`waeup.kofa`
 package. We don't tell someone that our code works, if we cannot prove
 it. And we prove it by testing.
@@ -246 +246 @@
   $ bin/test -c
 
-We have many tests in the :mod:`waeup.sirp` package so that sometimes
+We have many tests in the :mod:`waeup.kofa` package so that sometimes
 you only want the functional *or* the unit tests to run. This can be
 done like this::
@@ -277 +277 @@
 
   Most unit tests furthermore declare that they want to be run inside
-  the `WAeUPSIRPUnitTestLayer` defined in `waeup.sirp.testing`. This
-  layer groks the whole `waeup.sirp` package, so that all ZCA
+  the `WAeUPKofaUnitTestLayer` defined in `waeup.kofa.testing`. This
+  layer groks the whole `waeup.kofa` package, so that all ZCA
   components are already setup when you start your tests.
   
@@ -284 +284 @@
   layer, the testfile has to provide the following line::
 
-    .. :layer: waeup.sirp.testing.WAeUPSIRPUnitTestLayer
+    .. :layer: waeup.kofa.testing.WAeUPKofaUnitTestLayer
 
   Use it, if in your tests you make use of registered components like

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

@@ -7 +7 @@
    developernotes
    api/index
-   german/index