[Checkins] SVN: z3c.preference/trunk/ improved long_description aka PyPI page

[Michael Howitz]

Log message for revision 123879:
  improved long_description aka PyPI page

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

-=-
Modified: z3c.preference/trunk/CHANGES.txt
===================================================================
--- z3c.preference/trunk/CHANGES.txt	2012-01-02 12:42:30 UTC (rev 123878)
+++ z3c.preference/trunk/CHANGES.txt	2012-01-02 12:53:58 UTC (rev 123879)
@@ -1,21 +1,20 @@
-=======
 Changes
 =======
 
 
 0.1.2 (unreleased)
-==================
+------------------
 
 - Nothing changed yet.
 
 
 0.1.1 (2010-07-17)
-==================
+------------------
 
 - Documented preconditions to use this package, see `Using
   z3c.preference`_.
 
 0.1.0 (2010-07-10)
-==================
+------------------
 
 - Initial Release.

Modified: z3c.preference/trunk/TODO.txt
===================================================================
--- z3c.preference/trunk/TODO.txt	2012-01-02 12:42:30 UTC (rev 123878)
+++ z3c.preference/trunk/TODO.txt	2012-01-02 12:53:58 UTC (rev 123879)
@@ -1,6 +1,5 @@
+To do
 =======
- To do
-=======
 
 - Add a tree to access preferences deeper in the preference tree.
 

Modified: z3c.preference/trunk/setup.py
===================================================================
--- z3c.preference/trunk/setup.py	2012-01-02 12:42:30 UTC (rev 123878)
+++ z3c.preference/trunk/setup.py	2012-01-02 12:53:58 UTC (rev 123879)
@@ -16,7 +16,8 @@
 import os
 from setuptools import setup, find_packages
 
-def read(*rnames):
+def read(path):
+    rnames = path.split('/')
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
 setup (
@@ -25,15 +26,13 @@
     author = "Michael Howitz",
     author_email = "zope-dev at zope.org",
     description = "UI for zope.preference using z3c.pagelet and z3c.form.",
-    long_description=(
-        read('README.txt')
-        + '\n\n.. contents::\n\n' +
-        read('src', 'z3c', 'preference', 'README.txt')
-        + '\n\n' +
-        read('TODO.txt')
-        + '\n\n' +
-        read('CHANGES.txt')
-        ),
+    long_description='\n\n'.join([
+            read('README.txt'),
+            '.. contents::',
+            read('CHANGES.txt'),
+            read('src/z3c/preference/README.txt'),
+            read('TODO.txt'),
+        ]),
     license = "ZPL 2.1",
     keywords = "zope3 bluebream z3c preference ui",
     classifiers = [

Modified: z3c.preference/trunk/src/z3c/preference/README.txt
===================================================================
--- z3c.preference/trunk/src/z3c/preference/README.txt	2012-01-02 12:42:30 UTC (rev 123878)
+++ z3c.preference/trunk/src/z3c/preference/README.txt	2012-01-02 12:53:58 UTC (rev 123879)
@@ -1,6 +1,5 @@
-==============
-z3c.preference
-==============
+Overview
+========
 
 ``z3c.preference`` renders forms in the browser for the preference
 sets which were defined using zope.preference_.
@@ -21,9 +20,11 @@
   permission to the users resp. roles which should be able to access
   the preferences views.
 
+Editing preferences
+===================
 
 Set up for tests
-================
+----------------
 
 At first we have to define a preference interface:
 
@@ -62,7 +63,6 @@
   ...           id="BackEndSettings"
   ...           title="Back End Settings"
   ...           schema="z3c.preference.README.IBackEndSettings"
-  ...           category="true"
   ...           />
   ...
   ...     </configure>''', context)
@@ -76,8 +76,8 @@
 >>> browser.addHeader('Authorization', 'Basic mgr:mgrpw')
 
 
-Editing preferences
-===================
+Editing preferences using browser
+---------------------------------
 
 There is a name space to access the preferences. On the page a form is
 displayed which show the default values: