Eval¶
Provide setup()
to
sphinx.
- sphinxcontrib.eval.eval_bash(input: str) str ¶
Eval bash.
- Parameters:
input (str) –
- Return type:
str
- sphinxcontrib.eval.eval_python(input: str) str ¶
Eval python.
- Parameters:
input (str) –
- Return type:
str
- sphinxcontrib.eval.eval_sh(input: str) str ¶
Eval sh.
- Parameters:
input (str) –
- Return type:
str
- sphinxcontrib.eval.setup(app: Sphinx) dict[str, Any] ¶
Set up.
- Parameters:
app (Sphinx) –
- Return type:
dict[str, Any]
MyST¶
Provide MystEvalParser
.
RST¶
Provide RSTEvalParser
.
Utilities¶
- sphinxcontrib.eval.utils.get_lang_map(template: str, eval_funcs: dict[str, Callable[[str], str]]) dict[str, tuple[re.Pattern, Callable[[str], str]]] ¶
Get lang map.
- Parameters:
template (str) –
eval_funcs (dict[str, Callable[[str], str]]) –
- Return type:
dict[str, tuple[re.Pattern, Callable[[str], str]]]
- sphinxcontrib.eval.utils.patch_parser(template: str, parser: Type[Parser]) Type[Parser] ¶
Patch parser.
- Parameters:
template (str) –
parser (Type[Parser]) –
- Return type:
Type[Parser]
- sphinxcontrib.eval.utils.replace(inputstring: str, pat: Pattern, eval_func: Callable[[str], str]) str ¶
Replace.
- Parameters:
inputstring (str) –
pat (re.Pattern) –
eval_func (Callable[[str], str]) –
- Return type:
str