[Checkins] SVN: zc.async/trunk/DEVELOP.txt Bring DEVELOP.txt up-to-date.
Gary Poster
gary at modernsongs.com
Mon Sep 15 20:23:58 EDT 2008
Log message for revision 91186:
Bring DEVELOP.txt up-to-date.
Changed:
U zc.async/trunk/DEVELOP.txt
-=-
Modified: zc.async/trunk/DEVELOP.txt
===================================================================
--- zc.async/trunk/DEVELOP.txt 2008-09-16 00:17:53 UTC (rev 91185)
+++ zc.async/trunk/DEVELOP.txt 2008-09-16 00:23:58 UTC (rev 91186)
@@ -1,3 +1,6 @@
+BUILDING
+========
+
To develop this package from source:
- check out the software from the repository
@@ -9,13 +12,22 @@
- run ``./bin/buildout``
-To run tests, run *both* of the following:
+TESTING
+=======
+To run tests, run *all three* of the following:
+
- ``./bin/test``: this tests zc.async without any zope.app stuff
-- ``./bin/z3test``: this tests zc.async with zc.z3monitor code, along with a
- lot of zope.app that it drags along.
+- ``./bin/z3test``: this tests zc.async monitoring with zc.monitor code, which
+ just adds itself (zc.monitor), zc.ngi, and simplejson as dependencies.
+- ``./bin/z3test``: this tests zc.async with a big chunk of Zope 3, and with
+ zc.z3monitor code (a package of Zope 3-specific helpers for zc.monitor).
+
+RELEASING
+=========
+
Changes should be documented in CHANGES.txt *in the package*.
Before making a release that registers the software to PyPI, run the following:
@@ -31,7 +43,11 @@
Once this works, go ahead and ``./bin/py setup.py sdist register upload``.
BUILDING SPHINX DOCS
+====================
-sphinx-build -b <builder> sphinx sphinx/.build
+Use this command::
-Then tar the resulting files in the sphinx/.build directory and upload to PyPI.
+ sphinx-build -b <builder> sphinx sphinx/.build
+
+You'll want to use the "html" builder for PyPI upload. Then tar the resulting
+files in the sphinx/.build directory and upload to PyPI.
More information about the Checkins
mailing list