docutils.core

Package docutils :: Module core

[show private | hide private]

Module docutils.core

Calling the publish_* convenience functions (or instantiating a Publisher object) with component names will result in default behavior. For custom behavior (setting component options), create custom component objects first, and pass them to publish_*/Publisher.

Classes
`Publisher`	A facade encapsulating the high-level logic of a Docutils system.

Function Summary
	`publish_cmdline(reader, reader_name, parser, parser_name, writer, writer_name, settings, settings_spec, settings_overrides, enable_exit, argv, usage, description)` Set up & run a `Publisher`.
	`publish_file(source, source_path, destination, destination_path, reader, reader_name, parser, parser_name, writer, writer_name, settings, settings_spec, settings_overrides, enable_exit)` Set up & run a `Publisher`.
	`publish_string(source, source_path, destination_path, reader, reader_name, parser, parser_name, writer, writer_name, settings, settings_spec, settings_overrides, enable_exit)` Set up & run a `Publisher`, and return the string output.

Variable Summary
`str`	`default_description` = `'Reads from <source> (default is s...`
`str`	`default_usage` = `'%prog [options] [<source> [<destination...`

Function Details

publish_cmdline(reader=None, reader_name='standalone', parser=None, parser_name='restructuredtext', writer=None, writer_name='pseudoxml', settings=None, settings_spec=None, settings_overrides=None, enable_exit=1, argv=None, usage='%prog [options] [<source> [<destination>]]', description='Reads from <source> (default is stdin) and writes to <de...)

Set up & run a Publisher. For command-line front ends.

Parameters:

reader: A docutils.readers.Reader object.
reader_name: Name or alias of the Reader class to be instantiated if no reader supplied.
parser: A docutils.parsers.Parser object.
parser_name: Name or alias of the Parser class to be instantiated if no parser supplied.
writer: A docutils.writers.Writer object.
writer_name: Name or alias of the Writer class to be instantiated if no writer supplied.
settings: Runtime settings object.
settings_spec: Extra settings specification; a docutils.SettingsSpec subclass. Used only if no settings specified.
settings_overrides: A dictionary containing program-specific overrides of component settings.
enable_exit: Boolean; enable exit status at end of processing?
argv: Command-line argument list to use instead of sys.argv[1:].
usage: Usage string, output if there's a problem parsing the command line.
description: Program description, output for the "--help" option (along with command-line option descriptions).

publish_file(source=None, source_path=None, destination=None, destination_path=None, reader=None, reader_name='standalone', parser=None, parser_name='restructuredtext', writer=None, writer_name='pseudoxml', settings=None, settings_spec=None, settings_overrides=None, enable_exit=None)

Set up & run a Publisher. For programmatic use with file-like I/O.

Parameters:

source: A file-like object (must have "read" and "close" methods).
source_path: Path to the input file. Opened if no source supplied. If neither source nor source_path are supplied, sys.stdin is used.
destination: A file-like object (must have "write" and "close" methods).
destination_path: Path to the input file. Opened if no destination supplied. If neither destination nor destination_path are supplied, sys.stdout is used.
reader: A docutils.readers.Reader object.
reader_name: Name or alias of the Reader class to be instantiated if no reader supplied.
parser: A docutils.parsers.Parser object.
parser_name: Name or alias of the Parser class to be instantiated if no parser supplied.
writer: A docutils.writers.Writer object.
writer_name: Name or alias of the Writer class to be instantiated if no writer supplied.
settings: Runtime settings object.
settings_spec: Extra settings specification; a docutils.SettingsSpec subclass. Used only if no settings specified.
settings_overrides: A dictionary containing program-specific overrides of component settings.
enable_exit: Boolean; enable exit status at end of processing?

publish_string(source, source_path=None, destination_path=None, reader=None, reader_name='standalone', parser=None, parser_name='restructuredtext', writer=None, writer_name='pseudoxml', settings=None, settings_spec=None, settings_overrides=None, enable_exit=None)

Set up & run a Publisher, and return the string output. For programmatic use with string I/O.

For encoded string output, be sure to set the "output_encoding" setting to the desired encoding. Set it to "unicode" for unencoded Unicode string output. Here's how:

publish_string(..., settings_overrides={'output_encoding': 'unicode'})

Similarly for Unicode string input (source):

publish_string(..., settings_overrides={'input_encoding': 'unicode'})

Parameters:

source: An input string; required. This can be an encoded 8-bit string (set the "input_encoding" setting to the correct encoding) or a Unicode string (set the "input_encoding" setting to "unicode").
source_path: Path to the file or object that produced source; optional. Only used for diagnostic output.
destination_path: Path to the file or object which will receive the output; optional. Used for determining relative paths (stylesheets, source links, etc.).
reader: A docutils.readers.Reader object.
reader_name: Name or alias of the Reader class to be instantiated if no reader supplied.
parser: A docutils.parsers.Parser object.
parser_name: Name or alias of the Parser class to be instantiated if no parser supplied.
writer: A docutils.writers.Writer object.
writer_name: Name or alias of the Writer class to be instantiated if no writer supplied.
settings: Runtime settings object.
settings_spec: Extra settings specification; a docutils.SettingsSpec subclass. Used only if no settings specified.
settings_overrides: A dictionary containing program-specific overrides of component settings.
enable_exit: Boolean; enable exit status at end of processing?

Variable Details

default_description

Type:: str
Value:: 'Reads from <source> (default is stdin) and writes to <destination> (d\ efault is stdout).'

default_usage

Type:: str
Value:: '%prog [options] [<source> [<destination>]]'

Generated by Epydoc 2.0 on Tue Jul 22 05:30:38 2003

http://epydoc.sf.net