File: preprocessors.rst

package info (click to toggle)
nbconvert 7.16.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,044 kB
  • sloc: python: 8,394; makefile: 199; javascript: 2
file content (63 lines) | stat: -rw-r--r-- 1,185 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Preprocessors
=============

.. module:: nbconvert.preprocessors
   :noindex:

.. seealso::

   :doc:`/config_options`
     Configurable options for the nbconvert application

.. autoclass:: Preprocessor

    .. automethod:: __init__

    .. automethod:: preprocess

    .. automethod:: preprocess_cell

Specialized preprocessors
-------------------------

Converting and extracting figures
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: ConvertFiguresPreprocessor

.. autoclass:: SVG2PDFPreprocessor

.. autoclass:: ExtractOutputPreprocessor

Converting text
~~~~~~~~~~~~~~~

.. autoclass:: LatexPreprocessor

.. autoclass:: HighlightMagicsPreprocessor

Metadata and header control
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: ClearMetadataPreprocessor

.. autoclass:: CSSHTMLHeaderPreprocessor

Removing/Manipulating cells, inputs, and outputs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: ClearOutputPreprocessor

.. autoclass:: CoalesceStreamsPreprocessor

.. autoclass:: RegexRemovePreprocessor

.. autoclass:: TagRemovePreprocessor

Executing Notebooks
~~~~~~~~~~~~~~~~~~~

.. autoclass:: ExecutePreprocessor
    :members:

.. autoclass:: CellExecutionError