4.6. sphinx.builders.html

Several HTML builders.

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

4.6.1. Functions

bold(text)
brown(text)
compile_matchers(patterns)
copy_static_entry(source, targetdir, builder) Copy a HTML builder static_path entry from source to targetdir.
copyfile(source, dest) Copy a file and its modification times, if possible.
darkgreen(text)
ensuredir(path) Ensure that a path exists.
get_stable_hash(obj) Return a stable hash for a Python data structure.
inline_all_toctrees(builder, docnameset, ...) Inline all toctrees in the tree.
iteritems(d, **kw) Return an iterator over the (key, value) pairs of a dictionary.
md5 Returns a md5 hash object; optionally initialized with a string
movefile(source, dest) Move a file, removing the destination if it exists.
new_document(source_path[, settings]) Return a new empty document object.
os_path(canonicalpath)
patmatch(name, pat) Return if name matches pat.
relative_uri(base, to) Return a relative URL from base to to.
ustrftime(format, *args)

4.6.2. Classes

Builder(app) Builds target formats from the reST sources.
DirectoryHTMLBuilder(app) A StandaloneHTMLBuilder that creates all HTML pages as “index.html” in a directory given by their pagename, so that generated URLs don’t have .html in them.
DocTreeInput([source, source_path, ...]) Adapter for document tree input.
DoctreeReader alias of Reader
HTMLTranslator(builder, *args, **kwds) Our custom HTML translator.
HTMLWriter(builder)
JSONHTMLBuilder(app) A builder that dumps the generated HTML into JSON files.
OptionParser([components, defaults, ...]) Parser for command-line and library use.
PickleHTMLBuilder(app) A Builder that dumps the generated HTML into pickle files.
Publisher([reader, parser, writer, source, ...]) A facade encapsulating the high-level logic of a Docutils system.
PygmentsBridge([dest, stylename, ...])
SerializingHTMLBuilder(app) An abstract builder that serializes the generated HTML.
SingleFileHTMLBuilder(app) A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page.
SmartyPantsHTMLTranslator(*args, **kwds) Handle ordinary text via smartypants, converting quotes and dashes to the correct entities.
StandaloneHTMLBuilder(app) Builds standalone HTML docs.
StringOutput([destination, ...]) Direct string output.
Theme(name[, warn]) Represents the theme chosen in the configuration.
WebHTMLBuilder alias of PickleHTMLBuilder
text_type alias of unicode