[Checkins] SVN: zc.form/trunk/ brougt docs in shape added them to long_description

[Michael Howitz]

Log message for revision 122895:
  brougt docs in shape added them to long_description

Changed:
  U   zc.form/trunk/CHANGES.txt
  U   zc.form/trunk/setup.py
  U   zc.form/trunk/src/zc/form/TODO.txt
  U   zc.form/trunk/src/zc/form/browser/combinationwidget.txt
  U   zc.form/trunk/src/zc/form/browser/mruwidget.txt

-=-
Modified: zc.form/trunk/CHANGES.txt
===================================================================
--- zc.form/trunk/CHANGES.txt	2011-09-22 14:42:55 UTC (rev 122894)
+++ zc.form/trunk/CHANGES.txt	2011-09-22 15:06:54 UTC (rev 122895)
@@ -1,6 +1,6 @@
-==================
-CHANGES in zc.form
-==================
+=======
+Changes
+=======
 
 0.2 (unreleased)
 ----------------

Modified: zc.form/trunk/setup.py
===================================================================
--- zc.form/trunk/setup.py	2011-09-22 14:42:55 UTC (rev 122894)
+++ zc.form/trunk/setup.py	2011-09-22 15:06:54 UTC (rev 122895)
@@ -1,5 +1,11 @@
 from setuptools import setup, find_packages
+import os.path
 
+
+def read(filepath):
+    return file(os.path.join(*filepath.split('/'))).read()
+
+
 setup(
     name="zc.form",
     version="0.1.3",
@@ -7,6 +13,14 @@
     package_dir={'':'src'},
     namespace_packages=['zc'],
     include_package_data=True,
+    long_description='\n\n'.join([
+        read('src/zc/form/README.txt'),
+        read('CHANGES.txt'),
+        '.. contents::',
+        read('src/zc/form/TODO.txt'),
+        read('src/zc/form/browser/combinationwidget.txt'),
+        read('src/zc/form/browser/mruwidget.txt'),
+        read('src/zc/form/browser/exceptionviews.txt')]),
     license="ZPL 2.1",
     install_requires=[
         'pytz',

Modified: zc.form/trunk/src/zc/form/TODO.txt
===================================================================
--- zc.form/trunk/src/zc/form/TODO.txt	2011-09-22 14:42:55 UTC (rev 122894)
+++ zc.form/trunk/src/zc/form/TODO.txt	2011-09-22 15:06:54 UTC (rev 122895)
@@ -1,37 +1,40 @@
-Tests
+====
+Todo
+====
 
-<content title= schema= fields= omit_fields= schemaprefix=
-  >
-  <require permission= attributes= interfaces=>
-  <allow attributes= interfaces=>
-  <add ...>
-    <buttons ...>
-      <button showDisabled= description=...>
-    </buttons>
-    <require ...>
-    <allow ...>
-    <macrotemplate name= source=>
-    <menuItem .../>
-    <widget .../>
-  </add>
-  <edit degradeInput= degradeDisplay= displayFields=>
-    ...
-    <schema prefix= source= fields= >
+Tests::
+
+  <content title= schema= fields= omit_fields= schemaprefix=
+    >
+    <require permission= attributes= interfaces=>
+    <allow attributes= interfaces=>
+    <add ...>
+      <buttons ...>
+        <button showDisabled= description=...>
+      </buttons>
+      <require ...>
+      <allow ...>
+      <macrotemplate name= source=>
+      <menuItem .../>
       <widget .../>
-    </schema>
-  </edit>
-  <display degradeDisplay=>
-  
-  </display>
-  <form degradeInput= degradeDisplay= displayFields= editFields=>
-    ...
-  </form>
-  <menuItem ...>
-</content>
+    </add>
+    <edit degradeInput= degradeDisplay= displayFields=>
+      ...
+      <schema prefix= source= fields= >
+        <widget .../>
+      </schema>
+    </edit>
+    <display degradeDisplay=>
 
-Be able to specify some fields as input and others as display would be nice
+    </display>
+    <form degradeInput= degradeDisplay= displayFields= editFields=>
+      ...
+    </form>
+    <menuItem ...>
+  </content>
 
-remove extra_script
+* Be able to specify some fields as input and others as display would be nice
 
-condition to show the form (and menu item) (e.g. 
-condition="not:context/finalized_date")
+* remove extra_script
+
+* condition to show the form (and menu item) (e.g. condition="not:context/finalized_date")

Modified: zc.form/trunk/src/zc/form/browser/combinationwidget.txt
===================================================================
--- zc.form/trunk/src/zc/form/browser/combinationwidget.txt	2011-09-22 14:42:55 UTC (rev 122894)
+++ zc.form/trunk/src/zc/form/browser/combinationwidget.txt	2011-09-22 15:06:54 UTC (rev 122895)
@@ -1,3 +1,7 @@
+===================
+ CombinationWidget
+===================
+
 The combinationwidget collects two or more subfields to provide a convenient
 way to specify a sequence of values.
 

Modified: zc.form/trunk/src/zc/form/browser/mruwidget.txt
===================================================================
--- zc.form/trunk/src/zc/form/browser/mruwidget.txt	2011-09-22 14:42:55 UTC (rev 122894)
+++ zc.form/trunk/src/zc/form/browser/mruwidget.txt	2011-09-22 15:06:54 UTC (rev 122895)
@@ -1,5 +1,6 @@
-Most Recently Used (MRU) Source Widget
-======================================
+========================================
+ Most Recently Used (MRU) Source Widget
+========================================
 
 The MRU widget keeps track of the last few values selected (on a per-principal
 basis) and allows quickly selecting from that list instead of using a query
@@ -113,7 +114,7 @@
     <select name="form.color" id="form.color">
       <option value="red_token" selected="selected">Red</option>
     </select>
-    ... 
+    ...
 
 And the query view is hidden because we have an MRU list::
 
@@ -142,7 +143,7 @@
       <option value="green_token" selected="selected">Green</option>
       <option value="red_token">Red</option>
     </select>
-    ... 
+    ...
 
 Clean up a bit::