]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add a stub for bundlebuilder documentation.
authorGeorg Brandl <georg@python.org>
Mon, 21 Jan 2008 16:36:00 +0000 (16:36 +0000)
committerGeorg Brandl <georg@python.org>
Mon, 21 Jan 2008 16:36:00 +0000 (16:36 +0000)
Doc/library/bundlebuilder.rst [new file with mode: 0644]
Doc/library/mac.rst

diff --git a/Doc/library/bundlebuilder.rst b/Doc/library/bundlebuilder.rst
new file mode 100644 (file)
index 0000000..41767c0
--- /dev/null
@@ -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>)
index 791eb8132e2e4810032a9dce7cef4201e99d26ab..9201e24b22d6a03edfb1b3dcc078852244cccd2e 100644 (file)
@@ -21,3 +21,4 @@ Mac-specific Python programming.
    autogil.rst
    carbon.rst
    colorpicker.rst
+   bundlebuilder.rst