Merge pull request #22 from zopefoundation/writing-persistent-objects

Writing persistent objects

.travis.yml

@@ -4,5 +4,6 @@ install:
     - bin/buildout
 script:
     - make html
+    - bin/test -v1
 notifications:
     email: false

buildout.cfg

 [buildout]
-develop =
+develop = .
 parts =
     stxpy
+    test
 
-versions = versions
-unzip = true
-eggs =
-
-[versions]
-zc.buildout =
-zc.recipe.egg =
+[test]
+recipe = zc.recipe.testrunner
+eggs = zodbdocumentationtests
 
 [stxpy]
 recipe = zc.recipe.egg

conf.py

@@ -40,16 +40,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'ZODB'
-copyright = u'2009-2011, Zope Foundation'
+copyright = u'2009-2016, Zope Foundation'
 
 # 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 = '3.10'
+version = '5.0'
 # The full version, including alpha/beta/rc tags.
-release = '3.10.3'
+#release = '3.10.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -61,12 +61,10 @@ release = '3.10.3'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['build']
+exclude_patterns = [
+    'README.rst',
+    'eggs/**',
+    ]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None

documentation/guide/index.rst

@@ -19,5 +19,4 @@ If you haven't yet, you should read the :ref:`Tutorial <tutorial-label>`.
    threading.rst
    packing-and-garbage-collection.rst
    blobs.rst
-   schema-migration.rst
    multi-databases.rst

setup.py

+name = 'zodbdocumentationtests'
+version = '0'
+
+from setuptools import setup
+
+setup(
+    name = name,
+    version = version,
+    author = "Jim Fulton",
+    author_email = "jim@jimfulton.info",
+    description = "ZODB documentation tests",
+    packages = [name],
+    package_dir = {'':'.'},
+    install_requires = ['manuel', 'six', 'zope.testing', 'ZODB'],
+    )

zodbdocumentationtests/__init__.py

+#

zodbdocumentationtests/tests.py

+##############################################################################
+#
+# Copyright (c) Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (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.
+#
+##############################################################################
+import os
+import doctest
+import unittest
+import manuel.capture
+import manuel.doctest
+import manuel.testing
+import zope.testing.module
+
+from os.path import join
+
+def setUp(test):
+    import ZODB
+    test.globs.update(
+        ZODB=ZODB,
+        )
+    zope.testing.module.setUp(test)
+
+def tearDown(test):
+    zope.testing.module.tearDown(test)
+
+def test_suite():
+    here = os.path.dirname(__file__)
+    guide = join(here, '..', 'documentation', 'guide')
+
+    return unittest.TestSuite((
+        manuel.testing.TestSuite(
+            manuel.doctest.Manuel() + manuel.capture.Manuel(),
+            join(guide, 'writing-persistent-objects.rst'),
+            setUp=setUp, tearDown=tearDown,
+            ),
+        ))
+
+if __name__ == '__main__':
+    unittest.main(defaultTest='test_suite')
+