[Checkins] SVN: zope.interface/trunk/ Add sphinx docs generation.

Dan Korostelev nadako at gmail.com
Sun Mar 1 16:41:09 EST 2009 

Log message for revision 97404:
  Add sphinx docs generation.
  Remove zpkg stuff.
  Cleanup CHANGES.txt formatting.

Changed:
  U   zope.interface/trunk/CHANGES.txt
  U   zope.interface/trunk/buildout.cfg
  U   zope.interface/trunk/setup.py
  D   zope.interface/trunk/src/zope/interface/DEPENDENCIES.cfg
  D   zope.interface/trunk/src/zope/interface/PUBLICATION.cfg
  D   zope.interface/trunk/src/zope/interface/SETUP.cfg
  A   zope.interface/trunk/src/zope/interface/index.txt

-=-
Modified: zope.interface/trunk/CHANGES.txt
===================================================================
--- zope.interface/trunk/CHANGES.txt	2009-03-01 20:55:12 UTC (rev 97403)
+++ zope.interface/trunk/CHANGES.txt	2009-03-01 21:41:09 UTC (rev 97404)
@@ -1,18 +1,19 @@
-zope.interface Package Changes
-******************************
+*******
+CHANGES
+*******
 
-==================
 3.5.1 (unreleased)
-==================
+------------------
 
 - verifyObject: use getattr instead of hasattr to test for object attributes
   in order to let exceptions other than AttributeError raised by properties
   propagate to the caller
 
+- Add Sphinx-based documentation building to the package buildout configuration.
 
-==================
+
 3.5.0 (2008-10-26)
-==================
+------------------
 
 - Fixed declaration of _zope_interface_coptimizations, it's not a top level
   package.
@@ -30,46 +31,40 @@
 - Replaced `_flatten` with a non-recursive implementation, effectively making
   it 3x faster.
 
-==================
-3.4.1 (2007/10/02)
-==================
 
-Fixed a setup bug that prevented installation from source on systems
-without setuptools.
+3.4.1 (2007-10-02)
+------------------
 
-==================
-3.4.0 (2007/07/19)
-==================
+- Fixed a setup bug that prevented installation from source on systems
+  without setuptools.
 
-Final release for 3.4.0.
 
-====================
-3.4.0b3 (2007/05/22)
-====================
+3.4.0 (2007-07-19)
+------------------
 
-Bug Fixes
-=========
+- Final release for 3.4.0.
 
+
+3.4.0b3 (2007-05-22)
+--------------------
+
 - Objects with picky custom comparison methods couldn't be added to
   component registries.  Now, when checking whether an object is
   already registered, identity comparison is used.
 
-====================
-3.3.0.1 (2007/01/03)
-====================
 
-Bug Fixes
-=========
+3.3.0.1 (2007-01-03)
+--------------------
 
 - Made a reference to OverflowWarning, which disappeared in Python
   2.5, conditional.
 
-==================
+
 3.3.0 (2007/01/03)
-==================
+------------------
 
 New Features
-============
+~~~~~~~~~~~~
 
 - The adapter-lookup algorithim was refactored to make it
   much simpler and faster.  
@@ -78,7 +73,7 @@
   debugging of application code easier, since there is less
   infrastructre code to step through.
 
-- We now treat objects without interafce declarations as if they
+- We now treat objects without interface declarations as if they
   declared that they provide zope.interface.Interface.
 
 - There are a number of richer new adapter-registration interfaces
@@ -89,45 +84,37 @@
   zope.interface.taggedValue).
 
 Bug Fixes
-=========
+~~~~~~~~~
 
 - A bug in multi-adapter lookup sometimes caused incorrect adapters to
   be returned.
 
 
-===========================================
-zope.interface version 3.2.0.2 (2006/04/15)
-===========================================
+3.2.0.2 (2006-04-15)
+--------------------
 
 - Fix packaging bug:  'package_dir' must be a *relative* path.
 
 
-===========================================
-zope.interface version 3.2.0.1 (2006/04/14)
-===========================================
+3.2.0.1 (2006-04-14)
+--------------------
 
 - Packaging change:  suppress inclusion of 'setup.cfg' in 'sdist' builds.
 
 
-=========================================
-zope.interface version 3.2.0 (2006/01/05)
-=========================================
+3.2.0 (2006-01-05)
+------------------
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope 3.2.0 release.
 
-- TODO:  note other changes
 
+3.1.0 (2005-10-03)
+------------------
 
-=========================================
-zope.interface version 3.1.0 (2005/10/03)
-=========================================
-
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope 3.1.0 release.
 
-- TODO:  note other changes
-
 - Made attribute resolution order consistent with component lookup order,
   i.e. new-style class MRO semantics.
 
@@ -135,9 +122,8 @@
   favor of 'implementedBy' and 'providedBy'.
 
 
-=========================================
-zope.interface version 3.0.1 (2005/07/27)
-=========================================
+3.0.1 (2005-07-27)
+------------------
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope X3.0.1 release.
@@ -146,9 +132,8 @@
   to fail occasionally to reflect declaration changes.
 
 
-=========================================
-zope.interface version 3.0.0 (2004/11/07)
-=========================================
+3.0.0 (2004-11-07)
+------------------
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope X3.0.0 release.

Modified: zope.interface/trunk/buildout.cfg
===================================================================
--- zope.interface/trunk/buildout.cfg	2009-03-01 20:55:12 UTC (rev 97403)
+++ zope.interface/trunk/buildout.cfg	2009-03-01 21:41:09 UTC (rev 97404)
@@ -1,12 +1,19 @@
 [buildout]
 develop = .
-parts = test py
+parts = test python docs
 
 [test]
 recipe = zc.recipe.testrunner
 eggs = zope.interface
 
-[py]
+[python]
 recipe = zc.recipe.egg
 eggs = zope.interface
-interpreter = py
+interpreter = python
+
+[docs]
+recipe = z3c.recipe.sphinxdoc
+eggs = zope.interface [docs]
+build-dir = ${buildout:directory}/docs
+default.css =
+layout.html =

Modified: zope.interface/trunk/setup.py
===================================================================
--- zope.interface/trunk/setup.py	2009-03-01 20:55:12 UTC (rev 97403)
+++ zope.interface/trunk/setup.py	2009-03-01 21:41:09 UTC (rev 97404)
@@ -55,6 +55,7 @@
         zip_safe = False,
         tests_require = ['zope.testing'],
         install_requires = ['setuptools'],
+        extras_require={'docs': ['z3c.recipe.sphinxdoc']},
         features = {'codeoptimization': codeoptimization}
         )
 
@@ -64,8 +65,6 @@
 long_description=(
         read('README.txt')
         + '\n' +
-        read('CHANGES.txt')
-        + '\n' +
         'Detailed Documentation\n'
         '**********************\n'
         + '\n' +
@@ -75,6 +74,8 @@
         + '\n' +
         read('src', 'zope', 'interface', 'human.txt')
         + '\n' +
+        read('CHANGES.txt')
+        + '\n' +
         'Download\n'
         '**********************\n'
         )
@@ -113,11 +114,11 @@
 
 setup(name='zope.interface',
       version = '3.5.1dev',
-      url='http://www.python.org/pypi/zope.interface',
+      url='http://pypi.python.org/pypi/zope.interface',
       license='ZPL 2.1',
-      description='Zope 3 Interface Infrastructure',
+      description='Interfaces for Python',
       author='Zope Corporation and Contributors',
-      author_email='zope3-dev at zope.org',
+      author_email='zope-dev at zope.org',
       long_description=long_description,
 
       packages = ['zope', 'zope.interface'],

Deleted: zope.interface/trunk/src/zope/interface/DEPENDENCIES.cfg
===================================================================
--- zope.interface/trunk/src/zope/interface/DEPENDENCIES.cfg	2009-03-01 20:55:12 UTC (rev 97403)
+++ zope.interface/trunk/src/zope/interface/DEPENDENCIES.cfg	2009-03-01 21:41:09 UTC (rev 97404)
@@ -1 +0,0 @@
-zope.testing

Deleted: zope.interface/trunk/src/zope/interface/PUBLICATION.cfg
===================================================================
--- zope.interface/trunk/src/zope/interface/PUBLICATION.cfg	2009-03-01 20:55:12 UTC (rev 97403)
+++ zope.interface/trunk/src/zope/interface/PUBLICATION.cfg	2009-03-01 21:41:09 UTC (rev 97404)
@@ -1,8 +0,0 @@
-Metadata-Version: 1.0
-Name: zope.interface
-Summary: Zope 3 Interface Infrastructure
-Author: Zope Corporation and Contributors
-Author-email: zope3-dev at zope.org
-License: ZPL 2.1
-Description:
-        The implementation of interface definitions for Zope 3.

Deleted: zope.interface/trunk/src/zope/interface/SETUP.cfg
===================================================================
--- zope.interface/trunk/src/zope/interface/SETUP.cfg	2009-03-01 20:55:12 UTC (rev 97403)
+++ zope.interface/trunk/src/zope/interface/SETUP.cfg	2009-03-01 21:41:09 UTC (rev 97404)
@@ -1,5 +0,0 @@
-# Extension information for zpkg:
-
-<extension _zope_interface_coptimizations>
-  source _zope_interface_coptimizations.c
-</extension>

Added: zope.interface/trunk/src/zope/interface/index.txt
===================================================================
--- zope.interface/trunk/src/zope/interface/index.txt	                        (rev 0)
+++ zope.interface/trunk/src/zope/interface/index.txt	2009-03-01 21:41:09 UTC (rev 97404)
@@ -0,0 +1,29 @@
+Welcome to zope.interface's documentation!
+==========================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   README
+   adapter
+   human
+   verify
+
+По-русски
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   README.ru
+   adapter.ru
+   human.ru
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

More information about the Checkins mailing list