sphinx.jinja2glue

module documentation
(source)

Glue code for the jinja2 templating engine.

Class BuiltinTemplateLoader Interfaces the rendering environment of jinja2 for use in Sphinx.
Class idgen Undocumented
Class SphinxFileSystemLoader FileSystemLoader subclass that is not so strict about '..' entries in template names.
Function accesskey Helper to output each access key only once.
Function warning Undocumented
Function _slice_index Undocumented
Function _tobool Undocumented
Function _todim Make val a css dimension. In particular the following transformations are performed:
Function _toint Undocumented
def accesskey(context, key): (source)

Helper to output each access key only once.

Parameters
context:AnyUndocumented
key:strUndocumented
Returns
strUndocumented
@pass_context
def warning(context, message, *args, **kwargs): (source)

Undocumented

Parameters
context:dictUndocumented
message:strUndocumented
*args:AnyUndocumented
**kwargs:AnyUndocumented
Returns
strUndocumented
def _slice_index(values, slices): (source)

Undocumented

Parameters
values:listUndocumented
slices:intUndocumented
Returns
Iterator[list]Undocumented
def _tobool(val): (source)

Undocumented

Parameters
val:strUndocumented
Returns
boolUndocumented
def _todim(val): (source)

Make val a css dimension. In particular the following transformations are performed: - None -> 'initial' (default CSS value) - 0 -> '0' - ints and string representations of ints are interpreted as pixels. Everything else is returned unchanged.

Parameters
val:int|strUndocumented
Returns
strUndocumented
def _toint(val): (source)

Undocumented

Parameters
val:strUndocumented
Returns
intUndocumented