.. _f-processnotebookapi:

module ``helpgen.process_notebook_api``
=======================================







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

module ``pyquickhelper.helpgen.process_notebook_api``

Direct calls to IPython API without running a command line


:githublink:`%|py|6`






Functions
+++++++++

+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| function                                                                       | truncated documentation                                                                                  |
+================================================================================+==========================================================================================================+
| :func:`get_exporter <pyquickhelper.helpgen.process_notebook_api.get_exporter>` | Returns the :epkg:`IPython` exporter associated to a format.                                             |
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| :func:`nb2html <pyquickhelper.helpgen.process_notebook_api.nb2html>`           | Converts a notebook into HTML.                                                                           |
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| :func:`nb2rst <pyquickhelper.helpgen.process_notebook_api.nb2rst>`             | Converts a notebook into :epkg:`RST`.                                                                    |
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| :func:`nb2slides <pyquickhelper.helpgen.process_notebook_api.nb2slides>`       | Converts a notebook into slides, it copies :epkg:`reveal.js` if not present in the folder of the output. |
+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+








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

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