[Checkins] SVN: manuel/trunk/ - add a CHANGES.txt and top-level README.txt
Benji York
benji at zope.com
Fri Apr 24 08:26:55 EDT 2009
Log message for revision 99467:
- add a CHANGES.txt and top-level README.txt
- fix doc bug
- other small cleanups
Changed:
A manuel/trunk/CHANGES.txt
A manuel/trunk/README.txt
U manuel/trunk/setup.py
U manuel/trunk/src/manuel/README.txt
U manuel/trunk/src/manuel/doctest.py
U manuel/trunk/src/manuel/tests.py
-=-
Added: manuel/trunk/CHANGES.txt
===================================================================
--- manuel/trunk/CHANGES.txt (rev 0)
+++ manuel/trunk/CHANGES.txt 2009-04-24 12:26:54 UTC (rev 99467)
@@ -0,0 +1,15 @@
+=======
+CHANGES
+=======
+
+
+Unreleased
+----------
+
+Nothing yet.
+
+
+1.0.0a2 (2008-10-17)
+--------------------
+
+- First public release.
Property changes on: manuel/trunk/CHANGES.txt
___________________________________________________________________
Added: svn:eol-style
+ native
Added: manuel/trunk/README.txt
===================================================================
--- manuel/trunk/README.txt (rev 0)
+++ manuel/trunk/README.txt 2009-04-24 12:26:54 UTC (rev 99467)
@@ -0,0 +1 @@
+See src/menuel/README.txt
Property changes on: manuel/trunk/README.txt
___________________________________________________________________
Added: svn:eol-style
+ native
Modified: manuel/trunk/setup.py
===================================================================
--- manuel/trunk/setup.py 2009-04-24 12:09:07 UTC (rev 99466)
+++ manuel/trunk/setup.py 2009-04-24 12:26:54 UTC (rev 99467)
@@ -11,12 +11,20 @@
zip_safe=False,
author='Benji York',
author_email='benji at benjiyork.com',
- description='Design test syntax to match the task at hand and/or make '
- 'documentation testable.',
+ description=
+ 'Documentation and testing are important parts of software '
+ 'development. Often they can be combined such that you get tests '
+ 'that are well documented or documentation that is well tested. '
+ 'That\'s what Manuel is about.',
license='ZPL',
install_requires=[
'setuptools',
'zope.testing',
],
include_package_data=True,
+ long_description = (
+ open(os.path.join('src', 'manuel', 'README.txt')).read()
+ + '\n\n'
+ + open('CHANGES.txt').read()
+ )
)
Modified: manuel/trunk/src/manuel/README.txt
===================================================================
--- manuel/trunk/src/manuel/README.txt 2009-04-24 12:09:07 UTC (rev 99466)
+++ manuel/trunk/src/manuel/README.txt 2009-04-24 12:26:54 UTC (rev 99467)
@@ -6,7 +6,9 @@
they can be combined such that you get tests that are well documented or
documentation that is well tested. That's what Manuel is about.
+.. contents::
+
Overview
========
@@ -90,8 +92,8 @@
two: 4, 5, 7
three: 3, 5, 1
-Also, instead of a single "match" attribute, the region will have start_match
-and end_match attributes.
+Also, instead of just a "start_match" attribute, the region will have
+start_match and end_match attributes.
>>> region.start_match
<_sre.SRE_Match object at 0x...>
Modified: manuel/trunk/src/manuel/doctest.py
===================================================================
--- manuel/trunk/src/manuel/doctest.py 2009-04-24 12:09:07 UTC (rev 99466)
+++ manuel/trunk/src/manuel/doctest.py 2009-04-24 12:26:54 UTC (rev 99467)
@@ -1,9 +1,8 @@
-from zope.testing import doctest
import StringIO
-#import UserDict
import manuel
import os.path
+doctest = manuel.absolute_import('doctest')
class DocTestResult(StringIO.StringIO):
pass
Modified: manuel/trunk/src/manuel/tests.py
===================================================================
--- manuel/trunk/src/manuel/tests.py 2009-04-24 12:09:07 UTC (rev 99466)
+++ manuel/trunk/src/manuel/tests.py 2009-04-24 12:26:54 UTC (rev 99467)
@@ -1,4 +1,3 @@
-from zope.testing import doctest
from zope.testing import renormalizing
import manuel
import manuel.doctest
@@ -6,7 +5,7 @@
import re
import unittest
-#doctest = manuel.absolute_import('doctest')
+doctest = manuel.absolute_import('doctest')
def test_suite():
optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS
@@ -17,13 +16,11 @@
tests = ['README.txt', 'footnote.txt']
- # Run the tests once with just doctest.
- README = doctest.DocFileSuite(*tests, **{
- 'optionflags': optionflags,
- 'checker': checker})
- suite.addTest(README)
+ # Run the tests once with doctest.
+ suite.addTest(
+ doctest.DocFileSuite(optionflags=optionflags, checker=checker, *tests))
- # Run them again with manuel.
+ # Run them again with manuel's doctest support.
m = manuel.doctest.Manuel(optionflags=optionflags, checker=checker)
suite.addTest(manuel.testing.TestSuite(m, *tests))
More information about the Checkins
mailing list