ipypublish.main module

ipypublish.main.publish(ipynb_path, outformat='latex_ipypublish_main', outpath=None, dump_files=False, ignore_prefix='_', clear_files=False, create_pdf=False, pdf_in_temp=False, pdf_debug=False)[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

all files linked in the documents are placed into a single folder

  • ipynb_path – notebook file or directory
  • outformat (str) – output format to use
  • outpath (path_like) – path to output converted files
  • dump_files (bool) – whether to 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) – whether to convert to pdf (if converting to latex)
  • pdf_in_temp (bool) – whether to run pdf conversion in a temporary folder
  • pdf_debug (bool) – if True, run latexmk in interactive mode

outpath – path to output file

Return type: