Merge lp:~cjwatson/lazr.lifecycle/tox into lp:lazr.lifecycle

[Colin Watson]

Switch from buildout to tox.

[lp:~cjwatson/lazr.lifecycle/tox]

38. By Colin Watson on 2019-10-07

Switch from buildout to tox.

39. By Colin Watson on 2019-11-02

Move NEWS.rst to the top level, where it's easier to find.

[Ioana Lasc (ilasc)]

review: Approve

[lp:~cjwatson/lazr.lifecycle/tox]

40. By Colin Watson on 2019-11-04

Fix long description for PyPI.

=== modified file '.bzrignore'
--- .bzrignore	2009-08-29 16:12:02 +0000
+++ .bzrignore	2019-11-04 12:54:47 +0000
@@ -1,12 +1,10 @@
+*.egg-info
+*.pyc
+__pycache__
+.tox
 bin
-develop-eggs
-.installed.cfg
-develop-eggs
-parts
-*.egg-info
+build
+dist
 tags
 TAGS
-ID
-build
-*.egg
-dist
+src/lazr/lifecycle/docs/_build

=== renamed file 'HACKING.txt' => 'HACKING.rst'
--- HACKING.txt	2009-03-24 16:17:11 +0000
+++ HACKING.rst	2019-11-04 12:54:47 +0000
@@ -13,16 +13,11 @@
     You should have received a copy of the GNU Lesser General Public License
     along with lazr.lifecycle.  If not, see <http://www.gnu.org/licenses/>.
 
-This project uses zc.buildout for development.
-
 ============
 Introduction
 ============
 
-These are guidelines for hacking on the lazr.lifecycle project.  But first,
-please see the common hacking guidelines at:
-
-    http://dev.launchpad.net/Hacking
+To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`.
 
 
 Getting help

=== modified file 'MANIFEST.in'
--- MANIFEST.in	2009-08-29 16:09:41 +0000
+++ MANIFEST.in	2019-11-04 12:54:47 +0000
@@ -1,4 +1,3 @@
-include ez_setup.py
-recursive-include src *.txt *.pt *.zcml *.xsd
-exclude MANIFEST.in buildout.cfg bootstrap.py .bzrignore
-prune _bootstrap
+include COPYING.txt HACKING.rst NEWS.rst
+recursive-include src *.txt *.rst *.pt *.zcml *.xsd
+exclude MANIFEST.in .bzrignore

=== renamed file 'src/lazr/lifecycle/NEWS.txt' => 'NEWS.rst'
--- src/lazr/lifecycle/NEWS.txt	2019-10-07 09:11:43 +0000
+++ NEWS.rst	2019-11-04 12:54:47 +0000
@@ -8,12 +8,13 @@
 - Import IObjectEvent from zope.interface rather than zope.component.
 - Add ObjectModifiedEvent.descriptions property, for compatibility with
   zope.lifecycleevent >= 4.2.0.
+- Switch from buildout to tox.
 
 1.1 (2009-12-03)
 ================
 
 - Add IDoNotSnapshot and doNotSnapshot to allow the exclusion of
-certain fields.
+  certain fields.
 
 1.0 (2009-08-31)
 ================

=== renamed file 'README.txt' => 'README.rst'
=== removed directory '_bootstrap'
=== removed file '_bootstrap/COPYRIGHT.txt'
--- _bootstrap/COPYRIGHT.txt	2009-03-24 16:17:11 +0000
+++ _bootstrap/COPYRIGHT.txt	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-Copyright (c) 2004-2009 Zope Corporation and Contributors.
-All Rights Reserved.
-
-This software is subject to the provisions of the Zope Public License,
-Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-FOR A PARTICULAR PURPOSE.

=== removed file '_bootstrap/LICENSE.txt'
--- _bootstrap/LICENSE.txt	2009-03-24 16:17:11 +0000
+++ _bootstrap/LICENSE.txt	1970-01-01 00:00:00 +0000
@@ -1,54 +0,0 @@
-Zope Public License (ZPL) Version 2.1
--------------------------------------
-
-A copyright notice accompanies this license document that
-identifies the copyright holders.
-
-This license has been certified as open source. It has also
-been designated as GPL compatible by the Free Software
-Foundation (FSF).
-
-Redistribution and use in source and binary forms, with or
-without modification, are permitted provided that the
-following conditions are met:
-
-1. Redistributions in source code must retain the
-   accompanying copyright notice, this list of conditions,
-   and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the accompanying
-   copyright notice, this list of conditions, and the
-   following disclaimer in the documentation and/or other
-   materials provided with the distribution.
-
-3. Names of the copyright holders must not be used to
-   endorse or promote products derived from this software
-   without prior written permission from the copyright
-   holders.
-
-4. The right to distribute this software or to use it for
-   any purpose does not give you the right to use
-   Servicemarks (sm) or Trademarks (tm) of the copyright
-   holders. Use of them is covered by separate agreement
-   with the copyright holders.
-
-5. If any files are modified, you must cause the modified
-   files to carry prominent notices stating that you changed
-   the files and the date of any change.
-
-Disclaimer
-
-  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS''
-  AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
-  NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
-  NO EVENT SHALL THE COPYRIGHT HOLDERS BE
-  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
-  DAMAGE.
\ No newline at end of file

=== removed file '_bootstrap/bootstrap.py'
--- _bootstrap/bootstrap.py	2009-03-24 16:17:11 +0000
+++ _bootstrap/bootstrap.py	1970-01-01 00:00:00 +0000
@@ -1,77 +0,0 @@
-##############################################################################
-#
-# Copyright (c) 2006 Zope Corporation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-"""Bootstrap a buildout-based project
-
-Simply run this script in a directory containing a buildout.cfg.
-The script accepts buildout command-line options, so you can
-use the -c option to specify an alternate configuration file.
-
-$Id$
-"""
-
-import os, shutil, sys, tempfile, urllib2
-
-tmpeggs = tempfile.mkdtemp()
-
-is_jython = sys.platform.startswith('java')
-
-try:
-    import pkg_resources
-except ImportError:
-    ez = {}
-    exec urllib2.urlopen('http://peak.telecommunity.com/dist/ez_setup.py'
-                         ).read() in ez
-    ez['use_setuptools'](to_dir=tmpeggs, download_delay=0)
-
-    import pkg_resources
-
-if sys.platform == 'win32':
-    def quote(c):
-        if ' ' in c:
-            return '"%s"' % c # work around spawn lamosity on windows
-        else:
-            return c
-else:
-    def quote (c):
-        return c
-
-cmd = 'from setuptools.command.easy_install import main; main()'
-ws  = pkg_resources.working_set
-
-if is_jython:
-    import subprocess
-    
-    assert subprocess.Popen([sys.executable] + ['-c', quote(cmd), '-mqNxd', 
-           quote(tmpeggs), 'zc.buildout'], 
-           env=dict(os.environ,
-               PYTHONPATH=
-               ws.find(pkg_resources.Requirement.parse('setuptools')).location
-               ),
-           ).wait() == 0
-
-else:
-    assert os.spawnle(
-        os.P_WAIT, sys.executable, quote (sys.executable),
-        '-c', quote (cmd), '-mqNxd', quote (tmpeggs), 'zc.buildout',
-        dict(os.environ,
-            PYTHONPATH=
-            ws.find(pkg_resources.Requirement.parse('setuptools')).location
-            ),
-        ) == 0
-
-ws.add_entry(tmpeggs)
-ws.require('zc.buildout')
-import zc.buildout.buildout
-zc.buildout.buildout.main(sys.argv[1:] + ['bootstrap'])
-shutil.rmtree(tmpeggs)

=== removed symlink 'bootstrap.py'
=== target was u'_bootstrap/bootstrap.py'
=== removed file 'buildout.cfg'
--- buildout.cfg	2009-03-24 16:23:51 +0000
+++ buildout.cfg	1970-01-01 00:00:00 +0000
@@ -1,31 +0,0 @@
-[buildout]
-parts =
-    interpreter
-    test
-    docs
-    tags
-unzip = true
-
-develop = .
-
-[test]
-recipe = zc.recipe.testrunner
-eggs = lazr.lifecycle
-defaults = '--tests-pattern ^tests --exit-with-status --suite-name additional_tests'.split()
-
-[docs]
-recipe = z3c.recipe.sphinxdoc
-eggs = lazr.lifecycle [docs]
-index-doc = README
-default.css =
-layout.html =
-
-[interpreter]
-recipe = zc.recipe.egg
-interpreter=py
-eggs = lazr.lifecycle
-       docutils
-
-[tags]
-recipe = z3c.recipe.tag:tags
-eggs = lazr.lifecycle

=== removed file 'ez_setup.py'
--- ez_setup.py	2009-03-24 16:17:11 +0000
+++ ez_setup.py	1970-01-01 00:00:00 +0000
@@ -1,241 +0,0 @@
-#!python
-"""Bootstrap setuptools installation
-
-If you want to use setuptools in your package's setup.py, just include this
-file in the same directory with it, and add this to the top of your setup.py::
-
-    from ez_setup import use_setuptools
-    use_setuptools()
-
-If you want to require a specific version of setuptools, set a download
-mirror, or use an alternate download directory, you can do so by supplying
-the appropriate options to ``use_setuptools()``.
-
-This file can also be run as a script to install or upgrade setuptools.
-"""
-import sys
-DEFAULT_VERSION = "0.6c8"
-DEFAULT_URL     = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3]
-
-md5_data = {
-    'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
-    'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
-    'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
-    'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
-    'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
-    'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
-    'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
-    'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
-    'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
-    'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
-    'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
-    'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
-    'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
-    'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
-    'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
-    'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
-    'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
-    'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
-    'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
-    'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
-    'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
-    'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
-    'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
-    'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
-    'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
-    'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
-    'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
-    'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
-    'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
-    'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
-}
-
-import sys, os
-
-def _validate_md5(egg_name, data):
-    if egg_name in md5_data:
-        from md5 import md5
-        digest = md5(data).hexdigest()
-        if digest != md5_data[egg_name]:
-            print >>sys.stderr, (
-                "md5 validation of %s failed!  (Possible download problem?)"
-                % egg_name
-            )
-            sys.exit(2)
-    return data
-
-
-def use_setuptools(
-    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
-    download_delay=15, min_version=None
-):
-    """Automatically find/download setuptools and make it available on sys.path
-
-    `version` should be a valid setuptools version number that is available
-    as an egg for download under the `download_base` URL (which should end with
-    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
-    it is not already available.  If `download_delay` is specified, it should
-    be the number of seconds that will be paused before initiating a download,
-    should one be required.  If an older version of setuptools is installed,
-    this routine will print a message to ``sys.stderr`` and raise SystemExit in
-    an attempt to abort the calling script.
-    """
-    # Work around a hack in the ez_setup.py file from simplejson==1.7.3.
-    if min_version:
-        version = min_version
-
-    was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
-    def do_download():
-        egg = download_setuptools(version, download_base, to_dir, download_delay)
-        sys.path.insert(0, egg)
-        import setuptools; setuptools.bootstrap_install_from = egg
-    try:
-        import pkg_resources
-    except ImportError:
-        return do_download()       
-    try:
-        pkg_resources.require("setuptools>="+version); return
-    except pkg_resources.VersionConflict, e:
-        if was_imported:
-            print >>sys.stderr, (
-            "The required version of setuptools (>=%s) is not available, and\n"
-            "can't be installed while this script is running. Please install\n"
-            " a more recent version first, using 'easy_install -U setuptools'."
-            "\n\n(Currently using %r)"
-            ) % (version, e.args[0])
-            sys.exit(2)
-        else:
-            del pkg_resources, sys.modules['pkg_resources']    # reload ok
-            return do_download()
-    except pkg_resources.DistributionNotFound:
-        return do_download()
-
-def download_setuptools(
-    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
-    delay = 15
-):
-    """Download setuptools from a specified location and return its filename
-
-    `version` should be a valid setuptools version number that is available
-    as an egg for download under the `download_base` URL (which should end
-    with a '/'). `to_dir` is the directory where the egg will be downloaded.
-    `delay` is the number of seconds to pause before an actual download attempt.
-    """
-    import urllib2, shutil
-    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
-    url = download_base + egg_name
-    saveto = os.path.join(to_dir, egg_name)
-    src = dst = None
-    if not os.path.exists(saveto):  # Avoid repeated downloads
-        try:
-            from distutils import log
-            if delay:
-                log.warn("""
----------------------------------------------------------------------------
-This script requires setuptools version %s to run (even to display
-help).  I will attempt to download it for you (from
-%s), but
-you may need to enable firewall access for this script first.
-I will start the download in %d seconds.
-
-(Note: if this machine does not have network access, please obtain the file
-
-   %s
-
-and place it in this directory before rerunning this script.)
----------------------------------------------------------------------------""",
-                    version, download_base, delay, url
-                ); from time import sleep; sleep(delay)
-            log.warn("Downloading %s", url)
-            src = urllib2.urlopen(url)
-            # Read/write all in one block, so we don't create a corrupt file
-            # if the download is interrupted.
-            data = _validate_md5(egg_name, src.read())
-            dst = open(saveto,"wb"); dst.write(data)
-        finally:
-            if src: src.close()
-            if dst: dst.close()
-    return os.path.realpath(saveto)
-
-def main(argv, version=DEFAULT_VERSION):
-    """Install or upgrade setuptools and EasyInstall"""
-    try:
-        import setuptools
-    except ImportError:
-        egg = None
-        try:
-            egg = download_setuptools(version, delay=0)
-            sys.path.insert(0,egg)
-            from setuptools.command.easy_install import main
-            return main(list(argv)+[egg])   # we're done here
-        finally:
-            if egg and os.path.exists(egg):
-                os.unlink(egg)
-    else:
-        if setuptools.__version__ == '0.0.1':
-            print >>sys.stderr, (
-            "You have an obsolete version of setuptools installed.  Please\n"
-            "remove it from your system entirely before rerunning this script."
-            )
-            sys.exit(2)
-
-    req = "setuptools>="+version
-    import pkg_resources
-    try:
-        pkg_resources.require(req)
-    except pkg_resources.VersionConflict:
-        try:
-            from setuptools.command.easy_install import main
-        except ImportError:
-            from easy_install import main
-        main(list(argv)+[download_setuptools(delay=0)])
-        sys.exit(0) # try to force an exit
-    else:
-        if argv:
-            from setuptools.command.easy_install import main
-            main(argv)
-        else:
-            print "Setuptools version",version,"or greater has been installed."
-            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
-
-def update_md5(filenames):
-    """Update our built-in md5 registry"""
-
-    import re
-    from md5 import md5
-
-    for name in filenames:
-        base = os.path.basename(name)
-        f = open(name,'rb')
-        md5_data[base] = md5(f.read()).hexdigest()
-        f.close()
-
-    data = ["    %r: %r,\n" % it for it in md5_data.items()]
-    data.sort()
-    repl = "".join(data)
-
-    import inspect
-    srcfile = inspect.getsourcefile(sys.modules[__name__])
-    f = open(srcfile, 'rb'); src = f.read(); f.close()
-
-    match = re.search("\nmd5_data = {\n([^}]+)}", src)
-    if not match:
-        print >>sys.stderr, "Internal error!"
-        sys.exit(2)
-
-    src = src[:match.start(1)] + repl + src[match.end(1):]
-    f = open(srcfile,'w')
-    f.write(src)
-    f.close()
-
-
-if __name__=='__main__':
-    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
-        update_md5(sys.argv[2:])
-    else:
-        main(sys.argv[1:])
-
-
-
-
-

=== modified file 'setup.py'
--- setup.py	2019-08-21 12:10:12 +0000
+++ setup.py	2019-11-04 12:54:47 +0000
@@ -16,20 +16,19 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with lazr.lifecycle.  If not, see <http://www.gnu.org/licenses/>.
 
-import ez_setup
-ez_setup.use_setuptools()
-
-import sys
 from setuptools import setup, find_packages
 
 # generic helpers primarily for the long_description
 def generate(*docname_or_string):
+    marker = '.. pypi description ends here'
     res = []
     for value in docname_or_string:
-        if value.endswith('.txt'):
-            f = open(value)
-            value = f.read()
-            f.close()
+        if value.endswith('.rst'):
+            with open(value) as f:
+                value = f.read()
+            idx = value.find(marker)
+            if idx >= 0:
+                value = value[:idx]
         res.append(value)
         if not value.endswith('\n'):
             res.append('')
@@ -48,10 +47,10 @@
     zip_safe=False,
     maintainer='LAZR Developers',
     maintainer_email='[e-mail]',
-    description=open('README.txt').readline().strip(),
+    description=open('README.rst').readline().strip(),
     long_description=generate(
-        'src/lazr/lifecycle/README.txt',
-        'src/lazr/lifecycle/NEWS.txt'),
+        'src/lazr/lifecycle/docs/index.rst',
+        'NEWS.rst'),
     license='LGPL v3',
     install_requires=[
         'setuptools',
@@ -69,8 +68,7 @@
         "Operating System :: OS Independent",
         "Programming Language :: Python"],
     extras_require=dict(
-        docs=['Sphinx',
-              'z3c.recipe.sphinxdoc']
+        docs=['Sphinx'],
     ),
     test_suite='lazr.lifecycle.tests',
     )

=== added file 'src/lazr/lifecycle/docs/Makefile'
--- src/lazr/lifecycle/docs/Makefile	1970-01-01 00:00:00 +0000
+++ src/lazr/lifecycle/docs/Makefile	2019-11-04 12:54:47 +0000
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = lazrlifecycle
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

=== added symlink 'src/lazr/lifecycle/docs/NEWS.rst'
=== target is u'../../../../NEWS.rst'
=== added file 'src/lazr/lifecycle/docs/conf.py'
--- src/lazr/lifecycle/docs/conf.py	1970-01-01 00:00:00 +0000
+++ src/lazr/lifecycle/docs/conf.py	2019-11-04 12:54:47 +0000
@@ -0,0 +1,168 @@
+# -*- coding: utf-8 -*-
+#
+# lazr.lifecycle documentation build configuration file, created by
+# sphinx-quickstart on Wed Aug 21 12:58:44 2019.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'lazr.lifecycle'
+copyright = u'2019, LAZR Developers <[e-mail]>'
+author = u'LAZR Developers <[e-mail]>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u''
+# The full version, including alpha/beta/rc tags.
+release = u''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'lazrlifecycledoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'lazrlifecycle.tex', u'lazr.lifecycle Documentation',
+     u'LAZR Developers \\textless{}[e-mail]\\textgreater{}', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'lazrlifecycle', u'lazr.lifecycle Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'lazrlifecycle', u'lazr.lifecycle Documentation',
+     author, 'lazrlifecycle', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

=== renamed file 'src/lazr/lifecycle/docs/event.txt' => 'src/lazr/lifecycle/docs/event.rst'
=== renamed file 'src/lazr/lifecycle/README.txt' => 'src/lazr/lifecycle/docs/index.rst'
--- src/lazr/lifecycle/README.txt	2009-03-24 16:23:51 +0000
+++ src/lazr/lifecycle/docs/index.rst	2019-11-04 12:54:47 +0000
@@ -26,11 +26,15 @@
 The module also contains Snapshot support to save the state of an object for
 notification, and to compute deltas between version of objects.
 
+.. pypi description ends here
+
 Other documents
 ===============
 
 .. toctree::
    :glob:
 
-   *
-   docs/*
+   event
+   object-delta
+   snapshot
+   NEWS

=== renamed file 'src/lazr/lifecycle/docs/object-delta.txt' => 'src/lazr/lifecycle/docs/object-delta.rst'
=== renamed file 'src/lazr/lifecycle/docs/snapshot.txt' => 'src/lazr/lifecycle/docs/snapshot.rst'
=== modified file 'src/lazr/lifecycle/tests/test_docs.py'
--- src/lazr/lifecycle/tests/test_docs.py	2009-03-24 16:17:11 +0000
+++ src/lazr/lifecycle/tests/test_docs.py	2019-11-04 12:54:47 +0000
@@ -19,7 +19,7 @@
 
 __metaclass__ = type
 __all__ = [
-    'additional_tests',
+    'load_tests',
     ]
 
 import atexit
@@ -27,7 +27,6 @@
 import os
 from pkg_resources import (
     resource_filename, resource_exists, resource_listdir, cleanup_resources)
-import unittest
 import warnings
 
 DOCTEST_FLAGS = (
@@ -44,30 +43,36 @@
 
     print "%s: %s" % (kind, message)
 
+
 def setUp(test):
     """Makes any warning an error."""
     test.globs['saved_warn'] = warnings.warn
     warnings.warn = raise_warning
 
+
 def tearDown(test):
     """Reset the warnings."""
     warnings.warn = test.globs['saved_warn']
 
 
-def additional_tests():
-    "Run the doc tests (README.txt and docs/*, if any exist)"
-    doctest_files = [
-        os.path.abspath(resource_filename('lazr.lifecycle', 'README.txt'))]
+def find_doctests(suffix):
+    """Find doctests matching a certain suffix."""
+    doctest_files = []
+    # Match doctests against the suffix.
     if resource_exists('lazr.lifecycle', 'docs'):
         for name in resource_listdir('lazr.lifecycle', 'docs'):
-            if name.endswith('.txt'):
+            if name.endswith(suffix):
                 doctest_files.append(
                     os.path.abspath(
                         resource_filename('lazr.lifecycle', 'docs/%s' % name)))
-    kwargs = dict(
-        setUp=setUp, tearDown=tearDown,
-        module_relative=False,
-        optionflags=DOCTEST_FLAGS)
+    return doctest_files
+
+
+def load_tests(loader, tests, pattern):
+    """Load all the doctests."""
     atexit.register(cleanup_resources)
-    return unittest.TestSuite((
-        doctest.DocFileSuite(*doctest_files, **kwargs)))
+    tests.addTest(doctest.DocFileSuite(
+        *find_doctests('.rst'),
+        module_relative=False, setUp=setUp, tearDown=tearDown,
+        optionflags=DOCTEST_FLAGS))
+    return tests

=== added file 'tox.ini'
--- tox.ini	1970-01-01 00:00:00 +0000
+++ tox.ini	2019-11-04 12:54:47 +0000
@@ -0,0 +1,18 @@
+[tox]
+envlist = 
+    py27,docs
+
+[testenv]
+commands =
+    zope-testrunner --test-path src --tests-pattern ^tests {posargs}
+deps =
+    .[test]
+    zope.testrunner
+
+[testenv:docs]
+basepython =
+    python2.7
+commands =
+    sphinx-build -b html -d src/lazr/lifecycle/docs/_build/doctrees src/lazr/lifecycle/docs src/lazr/lifecycle/docs/_build/html
+deps =
+    .[docs]