sphinx.jinja2glue

module documentation

Glue code for the jinja2 templating engine.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ​Builtin​Template​Loader Interfaces the rendering environment of jinja2 for use in Sphinx.
Class idgen Undocumented
Class ​Sphinx​File​System​Loader FileSystemLoader subclass that is not so strict about '..' entries in template names.
Function ​_slice​_index Undocumented
Function ​_tobool Undocumented
Function ​_todim Make val a css dimension. In particular the following transformations are performed:
Function ​_toint Undocumented
Function accesskey Helper to output each access key only once.
Function warning Undocumented
def _slice_index(values, slices):

Undocumented

Parameters
values:ListUndocumented
slices:intUndocumented
Returns
Iterator[List]Undocumented
def _tobool(val):

Undocumented

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

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:Union[int, str]Undocumented
Returns
strUndocumented
def _toint(val):

Undocumented

Parameters
val:strUndocumented
Returns
intUndocumented
def accesskey(context, key):
Helper to output each access key only once.
Parameters
context:AnyUndocumented
key:strUndocumented
Returns
strUndocumented
@pass_context
def warning(context, message, *args, **kwargs):

Undocumented

Parameters
context:DictUndocumented
message:strUndocumented
*args:AnyUndocumented
**kwargs:AnyUndocumented
Returns
strUndocumented