Commit ceb9dcd6 authored by Jim Fulton's avatar Jim Fulton

Set expectations for the doctest docs. :)

parent feaa2286
...@@ -20,12 +20,21 @@ from setuptools import setup ...@@ -20,12 +20,21 @@ from setuptools import setup
def read(*rnames): def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read() return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
doc_intro = """
Below, you'll find doctest-based documentation. It was an expoeriment
in reusing tests as documentation. The experiment didn't go that
well, but there may be details below that aren't easy to find on
buildout.org yet.
doctest-based Documentation
***************************
"""
long_description=( long_description=(
read('README.rst') read('README.rst')
+ '\n' + + doc_intro +
'Detailed Documentation\n'
'**********************\n'
+ '\n' +
read('src', 'zc', 'buildout', 'buildout.txt') read('src', 'zc', 'buildout', 'buildout.txt')
+ '\n' + + '\n' +
read('src', 'zc', 'buildout', 'repeatable.txt') read('src', 'zc', 'buildout', 'repeatable.txt')
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment