\hypertarget{namespaceexcerpts_1_1main}{\section{excerpts.\+main Namespace Reference}
\label{namespaceexcerpts_1_1main}\index{excerpts.\+main@{excerpts.\+main}}
}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
def \hyperlink{namespaceexcerpts_1_1main_ac1df68b0d3c715c30d7361d5dea34885}{extract}
\begin{DoxyCompactList}\small\item\em Extract Matching Lines. \end{DoxyCompactList}\item 
def \hyperlink{namespaceexcerpts_1_1main_a5e56ed370605ce9d10cdf0472d44554a}{convert}
\begin{DoxyCompactList}\small\item\em Convert Lines to Markdown. \end{DoxyCompactList}\item 
def \hyperlink{namespaceexcerpts_1_1main_ae001c32da9a6230932a0a5ef60b67d16}{excerpt}
\begin{DoxyCompactList}\small\item\em Extract and Convert Matching Lines. \end{DoxyCompactList}\item 
def \hyperlink{namespaceexcerpts_1_1main_a7143bff678d0d683e5ad4a042f2f78b6}{modify\+\_\+path}
\begin{DoxyCompactList}\small\item\em Modify a Path. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Function Documentation}
\hypertarget{namespaceexcerpts_1_1main_a5e56ed370605ce9d10cdf0472d44554a}{\index{excerpts\+::main@{excerpts\+::main}!convert@{convert}}
\index{convert@{convert}!excerpts\+::main@{excerpts\+::main}}
\subsubsection[{convert}]{\setlength{\rightskip}{0pt plus 5cm}def excerpts.\+main.\+convert (
\begin{DoxyParamCaption}
\item[{}]{lines, }
\item[{}]{comment\+\_\+character, }
\item[{}]{magic\+\_\+character, }
\item[{}]{allow\+\_\+pep8 = {\ttfamily True}}
\end{DoxyParamCaption}
)}}\label{namespaceexcerpts_1_1main_a5e56ed370605ce9d10cdf0472d44554a}


Convert Lines to Markdown. 

Remove whitespace and magic characters from lines and output valid markdown.


\begin{DoxyParams}{Parameters}
{\em lines} & The lines to be converted. \\
\hline
{\em comment\+\_\+character} & The comment character of the language. \\
\hline
{\em magic\+\_\+character} & The magic character marking lines as excerpts. \\
\hline
{\em allow\+\_\+pep8} & Allow for a leading comment character and space to confrom to P\+E\+P 8 block comments. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A list of strings containing the lines converted. 
\end{DoxyReturn}


Here is the call graph for this function\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{namespaceexcerpts_1_1main_a5e56ed370605ce9d10cdf0472d44554a_cgraph}
\end{center}
\end{figure}


\hypertarget{namespaceexcerpts_1_1main_ae001c32da9a6230932a0a5ef60b67d16}{\index{excerpts\+::main@{excerpts\+::main}!excerpt@{excerpt}}
\index{excerpt@{excerpt}!excerpts\+::main@{excerpts\+::main}}
\subsubsection[{excerpt}]{\setlength{\rightskip}{0pt plus 5cm}def excerpts.\+main.\+excerpt (
\begin{DoxyParamCaption}
\item[{}]{lines, }
\item[{}]{comment\+\_\+character, }
\item[{}]{magic\+\_\+character, }
\item[{}]{allow\+\_\+pep8 = {\ttfamily True}}
\end{DoxyParamCaption}
)}}\label{namespaceexcerpts_1_1main_ae001c32da9a6230932a0a5ef60b67d16}


Extract and Convert Matching Lines. 

Just a wrapper to \hyperlink{namespaceexcerpts_1_1main_ac1df68b0d3c715c30d7361d5dea34885}{extract()} and \hyperlink{namespaceexcerpts_1_1main_a5e56ed370605ce9d10cdf0472d44554a}{convert()}.


\begin{DoxyParams}{Parameters}
{\em lines} & a list containing the code lines. \\
\hline
{\em comment\+\_\+character} & The comment character of the files language. \\
\hline
{\em magic\+\_\+character} & The magic character marking lines as excerpts. \\
\hline
{\em allow\+\_\+pep8} & Allow for a leading comment character and space to confrom to P\+E\+P 8 block comments. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A list of strings containing the lines extracted and converted. 
\end{DoxyReturn}


Here is the call graph for this function\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{namespaceexcerpts_1_1main_ae001c32da9a6230932a0a5ef60b67d16_cgraph}
\end{center}
\end{figure}


\hypertarget{namespaceexcerpts_1_1main_ac1df68b0d3c715c30d7361d5dea34885}{\index{excerpts\+::main@{excerpts\+::main}!extract@{extract}}
\index{extract@{extract}!excerpts\+::main@{excerpts\+::main}}
\subsubsection[{extract}]{\setlength{\rightskip}{0pt plus 5cm}def excerpts.\+main.\+extract (
\begin{DoxyParamCaption}
\item[{}]{lines, }
\item[{}]{comment\+\_\+character, }
\item[{}]{magic\+\_\+character, }
\item[{}]{allow\+\_\+pep8 = {\ttfamily True}}
\end{DoxyParamCaption}
)}}\label{namespaceexcerpts_1_1main_ac1df68b0d3c715c30d7361d5dea34885}


Extract Matching Lines. 

Extract all lines starting with a combination of comment\+\_\+character and magic\+\_\+character from a list.


\begin{DoxyParams}{Parameters}
{\em lines} & a list containing the code lines. \\
\hline
{\em comment\+\_\+character} & The comment character of the language. \\
\hline
{\em magic\+\_\+character} & The magic character marking lines as excerpts. \\
\hline
{\em allow\+\_\+pep8} & Allow for a leading comment character and space to confrom to P\+E\+P 8 block comments. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A list of strings containing the lines extracted. 
\end{DoxyReturn}


Here is the call graph for this function\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{namespaceexcerpts_1_1main_ac1df68b0d3c715c30d7361d5dea34885_cgraph}
\end{center}
\end{figure}


\hypertarget{namespaceexcerpts_1_1main_a7143bff678d0d683e5ad4a042f2f78b6}{\index{excerpts\+::main@{excerpts\+::main}!modify\+\_\+path@{modify\+\_\+path}}
\index{modify\+\_\+path@{modify\+\_\+path}!excerpts\+::main@{excerpts\+::main}}
\subsubsection[{modify\+\_\+path}]{\setlength{\rightskip}{0pt plus 5cm}def excerpts.\+main.\+modify\+\_\+path (
\begin{DoxyParamCaption}
\item[{}]{file\+\_\+name, }
\item[{}]{postfix = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{prefix = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{output\+\_\+path = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{}]{extension = {\ttfamily None}}
\end{DoxyParamCaption}
)}}\label{namespaceexcerpts_1_1main_a7143bff678d0d683e5ad4a042f2f78b6}


Modify a Path. 

Add a postfix and a prefix to the basename of a path and change it's extension.


\begin{DoxyParams}{Parameters}
{\em file\+\_\+name} & The file name to be modified. \\
\hline
{\em postfix} & Set the output file postfix. \\
\hline
{\em prefix} & Set the output file prefix. \\
\hline
{\em extension} & Set a new file extension. \\
\hline
{\em output\+\_\+path} & Set a new file name or an output directory. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A string containing the modified path. 
\end{DoxyReturn}
