summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-21 16:36:00 (GMT)
committerGeorg Brandl <georg@python.org>2008-01-21 16:36:00 (GMT)
commitd7e3e60b87623ea0e2117f42aa7e0351d4649fbb (patch)
tree679845405a33d5158ed0a89953b1484189666d72
parent864de8274c5d2904e1df6837450408cfdb6f9e11 (diff)
downloadcpython-d7e3e60b87623ea0e2117f42aa7e0351d4649fbb.zip
cpython-d7e3e60b87623ea0e2117f42aa7e0351d4649fbb.tar.gz
cpython-d7e3e60b87623ea0e2117f42aa7e0351d4649fbb.tar.bz2
Add a stub for bundlebuilder documentation.
-rw-r--r--Doc/library/bundlebuilder.rst28
-rw-r--r--Doc/library/mac.rst1
2 files changed, 29 insertions, 0 deletions
diff --git a/Doc/library/bundlebuilder.rst b/Doc/library/bundlebuilder.rst
new file mode 100644
index 0000000..41767c0
--- /dev/null
+++ b/Doc/library/bundlebuilder.rst
@@ -0,0 +1,28 @@
+:mod:`bundlebuilder` --- Assemble MacOS X (application) bundles
+===============================================================
+
+.. module:: bundlebuilder
+ :synopsis: Tools to assemble MacOS X (application) bundles.
+ :platform: Mac
+.. moduleauthor:: Just van Rossum
+
+.. index::
+ pair: creating; application bundles
+
+This module contains two classes to build so called "bundles" for MacOS X.
+:class:`BundleBuilder` is a general tool, :class:`AppBuilder` is a subclass
+specialized in building application bundles.
+
+These Builder objects are instantiated with a bunch of keyword arguments, and
+have a :meth:`build` method that will do all the work.
+
+The module also contains a main program that can be used in two ways::
+
+ % python bundlebuilder.py [options] build
+ % python buildapp.py [options] build
+
+where :file:`buildapp.py` is a user-supplied setup.py-like script following this
+model::
+
+ from bundlebuilder import buildapp
+ buildapp(<lots-of-keyword-args>)
diff --git a/Doc/library/mac.rst b/Doc/library/mac.rst
index 791eb81..9201e24 100644
--- a/Doc/library/mac.rst
+++ b/Doc/library/mac.rst
@@ -21,3 +21,4 @@ Mac-specific Python programming.
autogil.rst
carbon.rst
colorpicker.rst
+ bundlebuilder.rst