.. _f-nbconvertpreprocessor:

module ``helpgen._nbconvert_preprocessor``
==========================================





.. inheritance-diagram:: pyquickhelper.helpgen._nbconvert_preprocessor


Short summary
+++++++++++++

module ``pyquickhelper.helpgen._nbconvert_preprocessor``

Custom configuration for nbconvert,
see `custom_preprocessor <https://github.com/jupyter/nbconvert-examples/blob/master/custom_preprocessor/>`_


:githublink:`%|py|6`




Classes
+++++++

+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+
| class                                                                                                          | truncated documentation                                    |
+================================================================================================================+============================================================+
| :class:`LatexRawOutputPreprocessor <pyquickhelper.helpgen._nbconvert_preprocessor.LatexRawOutputPreprocessor>` | Custom processor to apply a different style on raw output. |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------+






Properties
++++++++++

+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                                       | truncated documentation                                                                                       |
+================================================================================================================================+===============================================================================================================+
| :meth:`cross_validation_lock <pyquickhelper.helpgen._nbconvert_preprocessor.LatexRawOutputPreprocessor.cross_validation_lock>` | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ... |
+--------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| method                                                                                                             | truncated documentation                                                                                              |
+====================================================================================================================+======================================================================================================================+
| :py:meth:`__init__ <pyquickhelper.helpgen._nbconvert_preprocessor.LatexRawOutputPreprocessor.__init__>`            | Overloads the constructor.                                                                                           |
+--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`preprocess_cell <pyquickhelper.helpgen._nbconvert_preprocessor.LatexRawOutputPreprocessor.preprocess_cell>` | Applies a transformation on each cell. See base.py for details, add ``\begin{verbatim}`` and ``\end{verbatim}``. ... |
+--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.helpgen._nbconvert_preprocessor
    :members:
    :special-members: __init__
    :show-inheritance: