sphinx.transforms.post_transforms.code.TrimDoctestFlagsTransform

class documentation

class TrimDoctestFlagsTransform(SphinxTransform): (source)

View In Hierarchy

Trim doctest flags like ``# doctest: +FLAG`` from python code-blocks. see :confval:`trim_doctest_flags` for more information.

Static Method is_pyconsole Undocumented
Method apply Undocumented
Method strip_doctest_flags Undocumented
Class Variable default_priority Undocumented

Inherited from SphinxTransform:

Property app Reference to the :class:`.Sphinx` object.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
@staticmethod
def is_pyconsole(node): (source)

Undocumented

Parameters
node:nodes.literal_blockUndocumented
Returns
boolUndocumented
def apply(self, **kwargs): (source)

Undocumented

Parameters
**kwargs:AnyUndocumented
def strip_doctest_flags(self, node): (source)

Undocumented

Parameters
node:TextElementUndocumented
default_priority = (source)

Undocumented