API Reference for Enthought Tool Suite 3.2.0
BUILD_DIR = os.path.join(os.path.abspath(os.getcwd()), 'build')
DOC_DIR = os.path.join(os.path.abspath(os.getcwd()), 'docs')
HTML_ZIP = os.path.join(DOC_DIR, ZIP_FILE_NAME)
SOURCE_DIR = os.path.join(DOC_DIR, 'source')
TARGET_DIR = os.path.join(BUILD_DIR, 'docs')
ZIP_FILE_NAME = 'html.zip'
Verify that value is True, False, 0, or 1
Create html_docs.zip in target directory. This is useful if the rst source files have recently been updated and a new zipped html file needs to be created for distribution. If commit is 1, html_docs.zip will replace the existing file in docs/ and be checked in to svn. This will only work if the user has commit access to svn.enthought.com/enthought.
Check to see if Sphinx is installed both by setuptools require and simple import. Return True or False based on results.
List the files to add to a project by inspecting the documentation directory. This works only if called after the build step, as the files have to be built.
returns a list of (install_dir, [data_files, ]) tuples.
Given a path to a zipfile, extract its contents to a given 'dest_dir'.
| Local name | Refers to |
|---|---|
| bdist_egg | setuptools.command.bdist_egg.bdist_egg |
| clean | distutils.command.clean.clean |
| Command | setuptools.Command |
| DistributionNotFound | pkg_resources.DistributionNotFound |
| DistutilsSetupError | distutils.errors.DistutilsSetupError |
| Extension | setuptools.Extension |
| find_packages | setuptools.find_packages |
| log | distutils.log |
| os | os |
| parse_version | pkg_resources.parse_version |
| require | pkg_resources.require |
| setup | setuptools.setup |
| shutil | shutil |
| subprocess | subprocess |
| sys | sys |
| VersionConflict | pkg_resources.VersionConflict |
| zipfile | zipfile |
© Copyright 2002-2009 Enthought, Inc.