.. _f-notebookexporter:

module ``helpgen.notebook_exporter``
====================================





.. inheritance-diagram:: pyquickhelper.helpgen.notebook_exporter


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

module ``pyquickhelper.helpgen.notebook_exporter``

Customer notebook exporters.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                      | truncated documentation                                                                                                                      |
+============================================================================================+==============================================================================================================================================+
| :class:`UpgradedRSTExporter <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter>` | Exports :epkg:`rst` documents. Overwrites `RSTExporter <https://github.com/jupyter/ nbconvert/blob/master/nbconvert/exporters/rst.py>`_. ... |
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                | truncated documentation                                                                                                                                                                            |
+=========================================================================================+====================================================================================================================================================================================================+
| :func:`convert_pandoc_rst <pyquickhelper.helpgen.notebook_exporter.convert_pandoc_rst>` | Overwrites `convert_pandoc <https://github.com/jupyter/nbconvert/blob/master/nbconvert/filters/pandoc.py>`_.                                                                                       |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_raw_html <pyquickhelper.helpgen.notebook_exporter.process_raw_html>`     | Replaces the output of `add_menu_notebook <http://www.xavierdupre.fr/app/jyquickhelper/helpsphinx/jyquickhelper/ helper_in_notebook.html#jyquickhelper.helper_in_notebook.add_notebook_menu>`_ ... |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

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






Methods
+++++++

+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                | truncated documentation                                                                                                      |
+=======================================================================================================+==============================================================================================================================+
| :py:meth:`__init__ <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter.__init__>`            | Overwrites the extra loaders to get the right template.                                                                      |
+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :meth:`default_filters <pyquickhelper.helpgen.notebook_exporter.UpgradedRSTExporter.default_filters>` | Overrides in subclasses to provide extra filters. This should return an iterable of 2-tuples: (name, class-or-function). ... |
+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+


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

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