excerpts.ui
index
/home/qwer/git/cyclops/fvafrcu/excerpts/excerpts/ui.py

@file
user interface functions

 
Modules
       
excerpts.main
excerpts.op

 
Functions
       
excerpts(file_name, comment_character='#', magic_character='%', output_path='', allow_pep8=True, 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().
 
Kwargs:
    file_name: The file from which the lines are to be extracted.
    pandoc_formats: The pandoc output formats to be used.
    run_pandoc: Run pandoc on the markdown file created?
    compile_latex: Compile the LaTeX file?
    postfix: Set the output file postfix.
    prefix: Set the output file prefix.
    comment_character: The comment character of the files language.
    output_path: Set a new file name or an output directory.
    allow_pep8: Remove a leading single comment character and blank.
    magic_character: The magic character marking lines as excerpts.
Returns:
    0 if output generation was successful.