Home       Trees       Index       Help   

Docutils

Package docutils :: Module frontend
[show private | hide private]
[frames | no frames]

Module docutils.frontend

Command-line and common processing for Docutils front-end tools.

Exports the following classes:

Classes
ConfigParser  
OptionParser Parser for command-line and library use.

Function Summary
  make_paths_absolute(pathdict, keys, base_path)
Interpret filesystem path settings relative to the base_path given.
  read_config_file(option, opt, value, parser)
Read a configuration file during option processing.
  set_encoding(option, opt, value, parser)
Validate & set the encoding specified.
  set_encoding_and_error_handler(option, opt, value, parser)
Validate & set the encoding and error handler specified.
  set_encoding_error_handler(option, opt, value, parser)
Validate & set the encoding error handler specified.
  store_multiple(option, opt, value, parser, *args, **kwargs)
Store multiple values in parser.values.
  validate_encoding(name, value)
  validate_encoding_and_error_handler(name, value)
  validate_encoding_error_handler(name, value)

Function Details

make_paths_absolute(pathdict, keys, base_path=None)

Interpret filesystem path settings relative to the base_path given.

Paths are values in pathdict whose keys are in keys. Get keys from OptionParser.relative_path_settings.

read_config_file(option, opt, value, parser)

Read a configuration file during option processing. (Option callback.)

set_encoding(option, opt, value, parser)

Validate & set the encoding specified. (Option callback.)

set_encoding_and_error_handler(option, opt, value, parser)

Validate & set the encoding and error handler specified. (Option callback.)

set_encoding_error_handler(option, opt, value, parser)

Validate & set the encoding error handler specified. (Option callback.)

store_multiple(option, opt, value, parser, *args, **kwargs)

Store multiple values in parser.values. (Option callback.)

Store None for each attribute named in args, and store the value for each key (attribute name) in kwargs.


   Home       Trees       Index       Help   

Docutils

Generated by Epydoc 2.0 on Tue Jul 22 05:30:40 2003 http://epydoc.sf.net