7.1. sphinx.websupport

Base Module for web support functions.

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

7.1.1. Functions

dump_json(obj, *args, **kwds)
ensuredir(path) Ensure that a path exists.
htmlescape(s[, quote]) Replace special characters “&”, “<” and “>” to HTML-safe sequences.
publish_parts(source[, source_path, ...]) Set up & run a Publisher, and return a dictionary of document parts.

7.1.2. Classes

BaseSearch(path)
Environment([block_start_string, ...]) The core component of Jinja is the Environment.
FileSystemLoader(searchpath[, encoding, ...]) Loads templates from the file system.
Sphinx(srcdir, confdir, outdir, doctreedir, ...)
StorageBackend
WebSupport([srcdir, builddir, datadir, ...]) The main API class for the web support package.