[Checkins] SVN: zope.annotation/trunk/ Clean up package description and documentation a bit.

[Dan Korostelev]

Log message for revision 97718:
  Clean up package description and documentation a bit.
  Change mailing list address to zope-dev.
  Remove old zpkg-related files.
  Remove version specification from zope.location dependency.
  Remove find-links from buildout.cfg.

Changed:
  U   zope.annotation/trunk/CHANGES.txt
  U   zope.annotation/trunk/README.txt
  U   zope.annotation/trunk/buildout.cfg
  U   zope.annotation/trunk/setup.py
  D   zope.annotation/trunk/src/zope/annotation/DEPENDENCIES.cfg
  U   zope.annotation/trunk/src/zope/annotation/README.txt

-=-
Modified: zope.annotation/trunk/CHANGES.txt
===================================================================
--- zope.annotation/trunk/CHANGES.txt	2009-03-09 19:03:51 UTC (rev 97717)
+++ zope.annotation/trunk/CHANGES.txt	2009-03-09 20:49:54 UTC (rev 97718)
@@ -1,27 +1,27 @@
-===========================
-Changes for zope.annotation
-===========================
+=======
+CHANGES
+=======
 
-==================
-3.5.0 (unreleased)
-==================
+3.4.2 (unreleased)
+------------------
 
-...
+- Clean up package description and documentation a bit.
 
+- Change mailing list address to zope-dev at zope.org, as
+  zope3-dev at zope.org is now retired.
 
-==================
+- Remove old zpkg-related files.
+
 3.4.1 (2008-08-26)
-==================
+------------------
 
-- Annotation factories take care not to store proxies in the database, so
-  adapting an object wrapped in a LocationProxy works correctly.
+- Annotation factories take care not to store proxies in the database,
+  so adapting an object wrapped in a ``LocationProxy`` works correctly.
   Fixes https://bugs.launchpad.net/zope3/+bug/261620
 
-
-==================
 3.4.0 (2007-08-29)
-==================
+------------------
 
 - Annotation factories are no longer containing the factored object.
-  Instead the objects are located using zope.location .  This removes
-  a dependency to zope.app.container .
+  Instead the objects are located using ``zope.location``. This removes
+  a dependency to ``zope.app.container``.

Modified: zope.annotation/trunk/README.txt
===================================================================
--- zope.annotation/trunk/README.txt	2009-03-09 19:03:51 UTC (rev 97717)
+++ zope.annotation/trunk/README.txt	2009-03-09 20:49:54 UTC (rev 97718)
@@ -1,4 +1 @@
-Zope Annotation
-***************
-
-.. contents::
+See src/zope/annotation/README.txt.

Modified: zope.annotation/trunk/buildout.cfg
===================================================================
--- zope.annotation/trunk/buildout.cfg	2009-03-09 19:03:51 UTC (rev 97717)
+++ zope.annotation/trunk/buildout.cfg	2009-03-09 20:49:54 UTC (rev 97718)
@@ -1,7 +1,6 @@
 [buildout]
 develop = . 
 parts = test
-find-links = http://download.zope.org/distribution/
 
 [test]
 recipe = zc.recipe.testrunner

Modified: zope.annotation/trunk/setup.py
===================================================================
--- zope.annotation/trunk/setup.py	2009-03-09 19:03:51 UTC (rev 97717)
+++ zope.annotation/trunk/setup.py	2009-03-09 20:49:54 UTC (rev 97718)
@@ -17,31 +17,19 @@
 """
 
 import os
-
 from setuptools import setup, find_packages
 
 def read(*rnames):
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
-long_description = (
-    read('README.txt')
-    + '\n' +
-    read('CHANGES.txt')
-    + '\n' +
-    'Detailed Documentation\n'
-    '**********************\n'
-    + '\n' +
-    read('src', 'zope', 'annotation', 'README.txt') 
-    )
-
 setup(
     name = 'zope.annotation',
     version = '3.5.0dev',
     url = 'http://pypi.python.org/pypi/zope.annotation',
     license = 'ZPL 2.1',
-    description = 'Zope annotation',
+    description = 'Object annotation mechanism',
     author = 'Zope Corporation and Contributors',
-    author_email = 'zope3-dev at zope.org',
+    author_email = 'zope-dev at zope.org',
     classifiers = [
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
@@ -52,14 +40,17 @@
         'Topic :: Internet :: WWW/HTTP',
         'Topic :: Software Development',
         ],
-    long_description = long_description,
+    long_description = \
+        read('src', 'zope', 'annotation', 'README.txt') 
+        + '\n\n' +
+        read('CHANGES.txt'),
     packages = find_packages('src'),
     package_dir = {'': 'src'},
     namespace_packages = ['zope',],
     install_requires = ['setuptools',
                         'zope.interface',
                         'zope.component',
-                        'zope.location>=3.4.0b1.dev-r78903',
+                        'zope.location',
                         'zope.proxy',
                         ],
     extras_require = dict(

Deleted: zope.annotation/trunk/src/zope/annotation/DEPENDENCIES.cfg
===================================================================
--- zope.annotation/trunk/src/zope/annotation/DEPENDENCIES.cfg	2009-03-09 19:03:51 UTC (rev 97717)
+++ zope.annotation/trunk/src/zope/annotation/DEPENDENCIES.cfg	2009-03-09 20:49:54 UTC (rev 97718)
@@ -1,5 +0,0 @@
-# _factory.py depends on zope.app
-zope.app
-zope.component
-zope.interface
-zope.testing

Modified: zope.annotation/trunk/src/zope/annotation/README.txt
===================================================================
--- zope.annotation/trunk/src/zope/annotation/README.txt	2009-03-09 19:03:51 UTC (rev 97717)
+++ zope.annotation/trunk/src/zope/annotation/README.txt	2009-03-09 20:49:54 UTC (rev 97718)
@@ -1,6 +1,13 @@
-Annotations
-===========
+==================
+Object Annotations
+==================
 
+This package provides a mechanism to store additional information about
+objects without need to modify object class.
+
+Annotation factories
+--------------------
+
 There is more to document about annotations, but we'll just sketch out
 a scenario on how to use the annotation factory for now. This is one
 of the easiest ways to use annotations -- basically you can see them
@@ -166,4 +173,3 @@
   True
   >>> removeAllProxies(located_polloi).__name__
   'my.other.key'
-