[Checkins] SVN: z3c.coverage/trunk/ Fix up documentation.

[Stephan Richter]

Log message for revision 83303:
  Fix up documentation.
  

Changed:
  U   z3c.coverage/trunk/CHANGES.txt
  U   z3c.coverage/trunk/setup.py
  U   z3c.coverage/trunk/src/z3c/coverage/README.txt

-=-
Modified: z3c.coverage/trunk/CHANGES.txt
===================================================================
--- z3c.coverage/trunk/CHANGES.txt	2008-01-29 18:22:32 UTC (rev 83302)
+++ z3c.coverage/trunk/CHANGES.txt	2008-01-29 18:26:05 UTC (rev 83303)
@@ -1,8 +1,9 @@
+=======
 CHANGES
--------
+=======
 
 1.1.0 (2008-01-29)
-~~~~~~~~~~~~~~~~~~
+------------------
 
 - Feature: The ``main()`` coverage report function now accepts the arguments
   of the script as a function argument, making it easier to configure the
@@ -18,32 +19,32 @@
 
 
 1.0.1 (2007-09-26)
-~~~~~~~~~~~~~~~~~~
+------------------
 
 - Bug: Fixed meta-data.
 
 
 1.0.0 (2007-09-26)
-~~~~~~~~~~~~~~~~~~
+------------------
 
 - First public release.
 
 
 0.2.1
-~~~~~
+-----
 
 - Feature: Added the ``--web`` option to ``coveragediff``.
 - Feature: Added a test suite.
 
 
 0.2.0
-~~~~~
+-----
 
 - Feature: Added ``coveragediff.py``.
 
 
 0.1.0
-~~~~~
+-----
 
 - Initial release of ``coveragereport.py``.
 

Modified: z3c.coverage/trunk/setup.py
===================================================================
--- z3c.coverage/trunk/setup.py	2008-01-29 18:22:32 UTC (rev 83302)
+++ z3c.coverage/trunk/setup.py	2008-01-29 18:26:05 UTC (rev 83303)
@@ -33,8 +33,10 @@
         'Detailed Documentation\n'
         '**********************'
         + '\n\n' +
-        read('src', 'z3c', 'formui', 'README.txt')
+        read('src', 'z3c', 'coverage', 'README.txt')
         + '\n\n' +
+        read('src', 'z3c', 'coverage', 'coveragediff.txt')
+        + '\n\n' +
         read('CHANGES.txt')
         ),
     license = "ZPL 2.1",

Modified: z3c.coverage/trunk/src/z3c/coverage/README.txt
===================================================================
--- z3c.coverage/trunk/src/z3c/coverage/README.txt	2008-01-29 18:22:32 UTC (rev 83302)
+++ z3c.coverage/trunk/src/z3c/coverage/README.txt	2008-01-29 18:26:05 UTC (rev 83303)
@@ -35,10 +35,10 @@
 
 
 API Tests
-=========
+---------
 
 ``CoverageNode`` Class
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~
 
 This class represents a node in the source tree. Simple modules are considered
 leaves and do not have children. Let's create a node for the `z3c` namespace
@@ -87,7 +87,7 @@
 
 
 `index_to_filename()` function
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Takes an indexed Python path and produces the cover filename for it:
 
@@ -98,7 +98,7 @@
   ''
 
 `index_to_nice_name()` function
--------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Takes an indexed Python path and produces a nice "human-readable" string:
 
@@ -110,7 +110,7 @@
 
 
 `index_to_name()` function
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Takes an indexed Python path and produces a "human-readable" string:
 
@@ -122,7 +122,7 @@
 
 
 `percent_to_colour()` function
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Given a coverage percentage, this function returns a color to represent the
 coverage:
@@ -138,7 +138,7 @@
 
 
 `get_svn_revision()` function
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Given a path, the function tries to determine the revision number of the
 file. If it fails, "UNKNOWN" is returned:
@@ -152,7 +152,7 @@
 
 
 `syntax_highlight()` function
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This function takes a cover file, converts it to a nicely colored HTML output:
 
@@ -177,7 +177,7 @@
 
 
 `coveragereport.py` is a script
--------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For convenience you can download the ``coveragereport.py`` module and run it
 as a script: