fridom.framework.utils.decorators.skip_on_doc_build

fridom.framework.utils.decorators.skip_on_doc_build(func: callable) → callable

Skip a function when building the documentation.

Description

This decorator skips a function when building the documentation. This is useful to avoid expensive computations during the documentation build.

Parameters

funccallable

The function to skip.

Returns

callable

The function that is skipped when building the documentation.

Examples

>>> import fridom.framework as fr
>>> @fr.utils.skip_on_doc_build
... def my_function():
...     return "This function is skipped when building the documentation."