4.5. sphinx.builders.gettext

The MessageCatalogBuilder class.

copyright:Copyright 2007-2016 by the Sphinx team, see AUTHORS.
license:BSD, see LICENSE for details.

4.5.1. Functions

bold(text)
darkgreen(text)
ensuredir(path) Ensure that a path exists.
extract_messages(doctree) Extract translatable messages from a document tree.
find_catalog(docname, compaction)
iteritems(d, **kw) Return an iterator over the (key, value) pairs of a dictionary.
open(filename[, mode, encoding, errors, ...]) Open an encoded file using the given mode and return a wrapped version providing transparent encoding/decoding.
purple(text)
safe_relpath(path[, start])
split_index_msg(type, value)
time(() -> floating point number) Return the current time in seconds since the Epoch.
traverse_translatable_index(doctree) Traverse translatable index node from a document tree.
uuid4() Generate a random UUID.
walk(top[, topdown, onerror, followlinks]) Directory tree generator.

4.5.2. Classes

Builder(app) Builds target formats from the reST sources.
Catalog() Catalog of translatable messages.
I18nBuilder(app) General i18n builder.
LocalTimeZone(*args, **kw)
MessageCatalogBuilder(app) Builds gettext-style message catalogs (.pot files).
MsgOrigin(source, line) Origin holder for Catalog message origin.
datetime The year, month and day arguments are required.
defaultdict defaultdict(default_factory[, ...]) –> dict with default factory
timedelta Difference between two datetime values.
tzinfo Abstract base class for time zone info objects.