ipypublish.frontend.nbpublish module

ipypublish.frontend.nbpublish.nbpublish(ipynb_path, outformat='latex_ipypublish_main', outpath=None, dump_files=True, ignore_prefix='_', clear_files=False, create_pdf=False, pdf_in_temp=False, pdf_debug=False, launch_browser=False, log_level='INFO', dry_run=False, print_traceback=False, export_paths=())[source]

convert one or more Jupyter notebooks to a published format

paths can be string of an existing file or folder, or a pathlib.Path like object

Parameters

  • ipynb_path – notebook file or directory

  • outformat (str) – output format to use

  • outpath (str or pathlib.Path) – path to output converted files

  • dump_files (bool) – write files from nbconvert (containing images, etc) to outpath

  • ignore_prefix (str) – ignore ipynb files with this prefix

  • clear_files (str) – whether to clear existing external files in outpath folder

  • create_pdf (bool) – convert to pdf (if converting to latex)

  • pdf_in_temp (bool) – run pdf conversion in a temporary folder and only copy back the pdf file

  • pdf_debug (bool) – run latexmk in interactive mode

  • log_level (str) – the logging level (debug, info, critical, …)

ipypublish.frontend.nbpublish.run(sys_args=None)[source]