excerpts
 All Namespaces Files Functions
Functions
excerpts.ui Namespace Reference

Functions

def excerpts
 Extract, Convert and Save Markdown Style Comments From a File. More...
 

Function Documentation

def excerpts.ui.excerpts (   file_name,
  comment_character = "#",
  magic_character = "%",
  allow_pep8 = True,
  output_path = "",
  prefix = "",
  postfix = "",
  run_pandoc = True,
  compile_latex = False,
  pandoc_formats = "tex" 
)

Extract, Convert and Save Markdown Style Comments From a File.

This is merely a wrapper to excerpt(), modify_path() and pandoc().

Parameters
file_nameThe file from which the lines are to be extracted.
comment_characterThe comment character of the file's language.
magic_characterThe magic character marking lines as excerpts.
allow_pep8Remove a leading single comment character and blank.
output_pathSet a new file name or an output directory.
postfixSet the output file postfix.
prefixSet the output file prefix.
run_pandocRun pandoc on the markdown file created?
pandoc_formatsThe pandoc output formats to be used.
compile_latexCompile the LaTeX file? Only considered if "tex" is part of pandoc_formats.
Returns
0 if output generation was successful, 1 otherwise.