API Reference for Enthought Tool Suite 3.2.0

Variables

• BUILD_DIR

  BUILD_DIR = os.path.join(os.path.abspath(os.getcwd()), 'build')
  
  

• DOC_DIR

  DOC_DIR = os.path.join(os.path.abspath(os.getcwd()), 'docs')
  
  

• HTML_ZIP

  HTML_ZIP = os.path.join(DOC_DIR, ZIP_FILE_NAME)
  
  

• SOURCE_DIR

  SOURCE_DIR = os.path.join(DOC_DIR, 'source')
  
  

• TARGET_DIR

  TARGET_DIR = os.path.join(BUILD_DIR, 'docs')
  
  

• ZIP_FILE_NAME

  ZIP_FILE_NAME = 'html.zip'
  
  

Classes

• BuildDocs
• DistDocs
• MyClean - A hook to remove the generated documentation when cleaning

Function summary

• check_bool(dist, attr, value)
• check_string(dist, attr, value)
• create_html_zip(target, commit)
• get_source_dirs()
• is_sphinx_installed()
• list_docs_data_files(docs_location)
• show_formats()
• unzip_html_docs(src_path, dest_dir)

Functions

• check_bool(dist, attr, value)

  Verify that value is True, False, 0, or 1

• check_string(dist, attr, value)
• create_html_zip(target, commit)

  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.

• get_source_dirs()
• is_sphinx_installed()

  Check to see if Sphinx is installed both by setuptools require and simple import. Return True or False based on results.

• list_docs_data_files(docs_location)

  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.

• show_formats()
• unzip_html_docs(src_path, dest_dir)

  Given a path to a zipfile, extract its contents to a given 'dest_dir'.

Imported Names

© Copyright 2002-2009 Enthought, Inc.