Peano
convert-jupyter-notebooks Namespace Reference

Data Structures

class  Mode
 

Functions

def postprocess_markdown_line (line)
 currently_in_raw_data_box: Jupyter's markdown export does not preserve raw data cells. More...
 
def postprocess_notebook_markdown (str filename)
 Takes the markdown produced by nbconvert into something that plays along nicely with our Doxygen. More...
 

Variables

 current_mode = Mode.Text
 
 notebook_filename = os.path.join(dirpath, filename)
 
 name_without_extension = notebook_filename.replace(".ipynb", "")
 

Function Documentation

◆ postprocess_markdown_line()

def convert-jupyter-notebooks.postprocess_markdown_line (   line)

currently_in_raw_data_box: Jupyter's markdown export does not preserve raw data cells.

But we use them quite frequently. So we follow the convention that raw data cells should be indented. And then we automatically filter those lines out, and add the markup box around them.

Definition at line 24 of file convert-jupyter-notebooks.py.

Referenced by postprocess_notebook_markdown().

Here is the caller graph for this function:

◆ postprocess_notebook_markdown()

def convert-jupyter-notebooks.postprocess_notebook_markdown ( str  filename)

Takes the markdown produced by nbconvert into something that plays along nicely with our Doxygen.

filename: File without extension

Definition at line 60 of file convert-jupyter-notebooks.py.

References postprocess_markdown_line().

Here is the call graph for this function:

Variable Documentation

◆ current_mode

convert-jupyter-notebooks.current_mode = Mode.Text

Definition at line 21 of file convert-jupyter-notebooks.py.

◆ name_without_extension

convert-jupyter-notebooks.name_without_extension = notebook_filename.replace(".ipynb", "")

Definition at line 128 of file convert-jupyter-notebooks.py.

◆ notebook_filename

convert-jupyter-notebooks.notebook_filename = os.path.join(dirpath, filename)

Definition at line 120 of file convert-jupyter-notebooks.py.