4Suite API Documentation

Module Ft.Lib.DistExt.BuildDocs

Main distutils extensions for generating documentation

Copyright 2005 Fourthought, Inc. (USA).
Detailed license and copyright information: http://4suite.org/COPYRIGHT
Project home, documentation, distributions: http://4suite.org/
Classes:
Functions:
Fields:

Classes

class BuildDocs(distutils.cmd.Command)

Methods

run(self)

Methods inherited from class distutils.cmd.Command

__getattr__, __init__, announce, copy_file, copy_tree, debug_print, dump_options, ensure_dirname, ensure_filename, ensure_finalized, ensure_string, ensure_string_list, execute, get_command_name, get_finalized_command, get_sub_commands, make_archive, make_file, mkpath, move_file, reinitialize_command, run_command, set_undefined_options, spawn, warn

Fields

boolean_options = ['force']
command_name = 'build_docs'
description = 'build documentation files'
user_options = [('build-dir=', 'd', 'directory to "build" (generate) to'), ('force', 'f', 'forcibly build everything (ignore file timestamps)')]

Fields


class ExternalBuildDocs(distutils.cmd.Command)

Methods

__init__(self, dist, modules, scripts, docs, build_lib, build_dir, xml_dir, html_dir, text_dir, force, verbose, dry_run)
add_index_info(self, index, category, name, (xml, html, text))
build_html_index(self, index)
build_xml_index(self, index)
doc_extensions(self, extensions, index)
Create XML documentation for XPath/XSLT extensions
doc_modules(self, index, top_level)
doc_scripts(self, index)
document(self, category, name, sources, object, formatter)
locate(self, path, name=None)
render_doc(self, doc)
render_one(self, outfile, source, stylesheets, params)
run(self)

Methods inherited from class distutils.cmd.Command

__getattr__, announce, copy_file, copy_tree, debug_print, dump_options, ensure_dirname, ensure_filename, ensure_finalized, ensure_string, ensure_string_list, execute, finalize_options, get_command_name, get_finalized_command, get_sub_commands, initialize_options, make_archive, make_file, mkpath, move_file, reinitialize_command, run_command, set_undefined_options, spawn, warn

Fields

command_name = 'build_docs'

Fields

Functions

convert_path(pathname)
Return 'pathname' as a name that will work on the native filesystem, i.e. split it on '/' and put it back together again using the current directory separator. Needed because filenames in the setup script are always supplied in Unix style, and have to be converted to the local convention before we can actually use them in the filesystem. Raises ValueError on non-Unix-ish systems if 'pathname' either starts or ends with a slash.
copy_file(src, dst, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0)
Copy a file 'src' to 'dst'. If 'dst' is a directory, then 'src' is copied there with the same name; otherwise, it must be a filename. (If the file exists, it will be ruthlessly clobbered.) If 'preserve_mode' is true (the default), the file's mode (type and permission bits, or whatever is analogous on the current platform) is copied. If 'preserve_times' is true (the default), the last-modified and last-access times are copied as well. If 'update' is true, 'src' will only be copied if 'dst' does not exist, or if 'dst' does exist but is older than 'src'.

'link' allows you to make hard links (os.link) or symbolic links
(os.symlink) instead of copying: set it to "hard" or "sym"; if it is
None (the default), files are copied. Don't set 'link' on systems that
don't support it: 'copy_file()' doesn't check if hard or symbolic
linking is available.

Under Mac OS, uses the native file copy function in macostools; on
other systems, uses '_copy_file_contents()' to copy file contents.

Return a tuple (dest_name, copied): 'dest_name' is the actual name of
the output file, and 'copied' is true if the file was copied (or would
have been copied, if 'dry_run' true).
newer_group(sources, target, missing='error')
Return true if 'target' is out-of-date with respect to any file listed in 'sources'. In other words, if 'target' exists and is newer than every file in 'sources', return false; otherwise return true. 'missing' controls what we do when a source file is missing; the default ("error") is to blow up with an OSError from inside 'stat()'; if it is "ignore", we silently drop any missing source files; if it is "newer", any missing source files make us assume that 'target' is out-of-date (this is handy in "dry-run" mode: it'll make you pretend to carry out commands that wouldn't work because inputs are missing, but that doesn't matter because you're not actually going to run the commands).

Fields

PREAMBLE = "\n<p>Copyright 2001-2005 Fourthought, Inc., USA. ...te/'>Uche Ogbuji's 4Suite page</a>.</a></p>\n<hr>\n"