sphinx_gallery.notebook¶
Parser for Jupyter notebooks¶
Class that holds the Jupyter notebook information
Functions¶
-
sphinx_gallery.notebook.
add_code_cell
(work_notebook, code)[source]¶ Add a code cell to the notebook
- Parameters
code (str) – Cell content
-
sphinx_gallery.notebook.
add_markdown_cell
(work_notebook, text)[source]¶ Add a markdown cell to the notebook
- Parameters
code (str) – Cell content
-
sphinx_gallery.notebook.
fill_notebook
(work_notebook, script_blocks)[source]¶ Writes the Jupyter notebook cells
- Parameters
script_blocks (list) – Each list element should be a tuple of (label, content, lineno).
-
sphinx_gallery.notebook.
jupyter_notebook
(script_blocks, gallery_conf)[source]¶ Generate a Jupyter notebook file cell-by-cell
-
sphinx_gallery.notebook.
jupyter_notebook_skeleton
()[source]¶ Returns a dictionary with the elements of a Jupyter notebook
-
sphinx_gallery.notebook.
python_to_jupyter_cli
(args=None, namespace=None)[source]¶ Exposes the jupyter notebook renderer to the command line
Takes the same arguments as ArgumentParser.parse_args