| |
- convert(lines, comment_character, magic_character, allow_pep8=True)
- Convert Lines to Markdown
Remove whitespace and magic characters from lines and output valid
markdown.
Kwargs:
lines: The lines to be converted.
comment_character: The comment character of the files language.
magic_character: The magic character marking lines as excerpts.
allow_pep8: Remove a leading single comment character and blank.
Returns:
A list of strings containing the lines converted.
- excerpt(lines, comment_character, magic_character, allow_pep8=True)
- Extract and Convert Matching Lines
Just a wrapper to extract_md() and convert().
Kwargs:
lines: a list containing the code lines.
comment_character: The comment character of the files language.
magic_character: The magic character marking lines as excerpts.
allow_pep8: Remove a leading single comment character and blank.
Returns:
A list of strings containing the lines extracted and converted.
- extract_md(lines, comment_character, magic_character, allow_pep8=True)
- Extract Matching Lines
Extract all lines starting with a combination of comment_character and
magic_character from a list.
Kwargs:
lines: a list containing the code lines.
comment_character: The comment character of the language.
magic_character: The magic character marking lines as excerpts.
allow_pep8: Allow for a leading comment character and space to confrom
to PEP 8 block comments.
Returns:
A list of strings containing the lines extracted.
- modify_path(file_name, postfix='', prefix='', output_path='', extension=None)
- Modify a Path
Add a postfix and a prefix to the basename of a path and optionally change
it's extension.
Kwargs:
file_name: The file to be modified.
postfix: Set the output file postfix.
prefix: Set the output file prefix.
extension: Set a new file extension.
output_path: Set a new file name or an output directory.
Returns:
A string containing the modified path.
|