Added notebook output formatting style

templates/tex/latex_sphinx_base.tplx

@@ -1,356 +1,371 b''
 ((= NBConvert Sphinx-Latex Template
 
 Purpose: Allow export of PDF friendly Latex inspired by Sphinx.  Most of the
        template is derived directly from Sphinx source.
 
 Inheritance: null>display_priority>latex_base 
 
 Note: For best display, use latex syntax highlighting. =))
 
 ((*- extends 'display_priority.tplx' -*))
 
 %==============================================================================
 % Declarations
 %==============================================================================
 
 % In order to make sure that the input/output header follows the code it 
 % preceeds, the needspace package is used to request that a certain
 % amount of lines (specified by this variable) are reserved.  If those
 % lines aren't available on the current page, the documenter will break
 % to the next page and the header along with accomanying lines will be
 % rendered together.  This value specifies the number of lines that
 % the header will be forced to group with without a page break.
 ((*- set min_header_lines = 4 -*))
 
 % This is the number of characters that are permitted per line.  It's
 % important that this limit is set so characters do not run off the
 % edges of latex pages (since latex does not always seem smart enough
 % to prevent this in some cases.)  This is only applied to textual output
+((* if resources.sphinx.outputstyle == 'simple' *))
 ((*- set wrap_size = 85 -*)) 
+((* elif resources.sphinx.outputstyle == 'notebook' *))
+    ((*- set wrap_size = 70 -*)) 
+((* endif *))
 
 %==============================================================================
 % Header
 %==============================================================================
 ((* block header *))
 
 % Header, overrides base
 
     % Make sure that the sphinx doc style knows who it inherits from.
     \def\sphinxdocclass{(((parentdocumentclass)))}
 
     % Declare the document class
     \documentclass[letterpaper,10pt,english]{((( resources.sphinx.texinputs )))/sphinx(((documentclass)))}
 
     % Imports
     \usepackage[utf8]{inputenc}
     \DeclareUnicodeCharacter{00A0}{\\nobreakspace}
     \usepackage[T1]{fontenc}
     \usepackage{babel}
     \usepackage{times}
     \usepackage{import}
     \usepackage[((( resources.sphinx.chapterstyle )))]{((( resources.sphinx.texinputs )))/fncychap}
     \usepackage{longtable}
     \usepackage{((( resources.sphinx.texinputs )))/sphinx}
     \usepackage{multirow}
 
     \usepackage{amsmath}
     \usepackage{amssymb}
     \usepackage{ucs}
     \usepackage{enumerate}
 
     % Used to make the Input/Output rules follow around the contents.
     \usepackage{needspace}
 
     % Pygments requirements
     \usepackage{fancyvrb}
     \usepackage{color}
     
     % Needed to box output/input
     \usepackage{mdframed}
     \usepackage{alltt}
 
     % Used to load and display graphics
     \usepackage{graphicx}
     \graphicspath{ {figs/} }
 
     % For formatting output while also word wrapping.
     \usepackage{listings}
     \lstset{breaklines=true}
     \lstset{basicstyle=\small\ttfamily}
 
     %Pygments definitions
     ((( resources.sphinx.pygment_definitions )))
     
     %Set pygments styles if needed...
     ((* if resources.sphinx.outputstyle == 'notebook' *))
         \definecolor{nbframe-border}{rgb}{0.8,0.8,0.8}
         \definecolor{nbframe-bg}{rgb}{0.95,0.95,0.95}
         
-        \newenvironment{ColorVerbatim}[1][\unskip]
-        {#1\\*\vspace{-2.4\baselineskip}\begin{mdframed}[backgroundcolor=nbframe-bg,    userdefinedwidth=1\linewidth, leftmargin=0.08\linewidth, linecolor=nbframe-border, linewidth=1pt, usetwoside=false]}
+        \newenvironment{ColorVerbatim}
+        {\begin{mdframed}[backgroundcolor=nbframe-bg,    userdefinedwidth=1\linewidth, leftmargin=0.08\linewidth, linecolor=nbframe-border, linewidth=1pt, usetwoside=false]}
         {\end{mdframed}}
         
         \renewenvironment{Verbatim}[1][\unskip]
         {\begin{alltt}}
         {\end{alltt}}
     ((* endif *))
 
     % Help prevent overflowing lines due to urls and other hard-to-break 
     % entities.  This doesn't catch everything...
     \sloppy
 
     % Document level variables
     \title{((( nb.metadata.name | escape_tex )))}
     \date{((( nb.metadata._draft.date | escape_tex )))}
     \release{((( nb.metadata._draft.version | escape_tex )))}
     \author{((( nb.metadata._draft.author | escape_tex )))}
     \renewcommand{\releasename}{((( nb.metadata._draft.release | escape_tex )))}
     
     % TODO: Add option for the user to specify a logo for his/her export.
     \newcommand{\sphinxlogo}{}
 
     % Make the index page of the document.
     \makeindex
     
     % Import sphinx document type specifics.
     ((* block sphinxheader *))((* endblock sphinxheader *)) 
 ((* endblock header *))
 
 %==============================================================================
 % Body
 %==============================================================================
 ((* block body *))
 ((* block bodyBegin *))
 % Body
 
     % Start of the document
     \begin{document}
         \maketitle
         \tableofcontents 
 
         ((* endblock bodyBegin *))((( super() )))((* block bodyEnd *))
 
         \renewcommand{\indexname}{Index}
         \printindex
 
     % End of document
     \end{document}
 ((* endblock bodyEnd *))
 ((* endblock body *))
 
 %==============================================================================
 % Footer
 %==============================================================================
 ((* block footer *))
 ((* endblock footer *))
 
 %==============================================================================
 % Headings
 %
 % Purpose: Format pynb headers as sphinx headers.  Depending on the Sphinx
 %          style that is active, this will change.  Thus sphinx styles will
 %          override the values here.
 %==============================================================================
 ((* block headingcell -*))
     \
     ((*- if cell.level == 1 -*))
         ((* block h1 -*))part((* endblock h1 -*))
     ((*- elif cell.level == 2 -*))
         ((* block h2 -*))chapter((* endblock h2 -*))
     ((*- elif cell.level == 3 -*))
         ((* block h3 -*))section((* endblock h3 -*))
     ((*- elif cell.level == 4 -*))
         ((* block h4 -*))subsection((* endblock h4 -*))
     ((*- elif cell.level == 5 -*))
         ((* block h5 -*))subsubsection((* endblock h5 -*))
     ((*- elif cell.level == 6 -*))
         ((* block h6 -*))paragraph((* endblock h6 -*))
     
     ((= It's important to make sure that underscores (which tend to be common
     in IPYNB file titles) do not make their way into latex.  Sometimes this
     causes latex to barf. =))
     ((*- endif -*)){((( escape_underscores(cell.source | markdown2latex ) )))}
 ((*- endblock headingcell *))
 
 %==============================================================================
 % Markdown
 %
 % Purpose: Convert markdown to latex.  Here markdown2latex is explicitly
 %          called since we know we want latex output.
 %==============================================================================
 ((*- block markdowncell scoped-*))
     ((( cell.source | markdown2latex )))
 ((*- endblock markdowncell -*))
 
 %==============================================================================
 % Rawcell
 %
 % Purpose: Raw text cells allow the user to manually inject document code that 
 %          will not get touched by the templating system.
 %==============================================================================
 ((*- block rawcell *))
     ((( cell.source | wrap(wrap_size) )))
 ((* endblock rawcell -*))
 
 %==============================================================================
 % Unknowncell
 %
 % Purpose: This is the catch anything unhandled.  To display this data, we
 %          remove all possible latex conflicts and wrap the characters so they
 %          can't flow off of the page.
 %==============================================================================
 ((* block unknowncell scoped*))
 
     % Unsupported cell type, no formatting
     ((( cell.source | wrap | escape_tex )))
 ((* endblock unknowncell *))
 
 %==============================================================================
 % Input
 %==============================================================================
 ((* block input *))
     ((* if resources.sphinx.outputstyle == 'simple' *))
         % Make sure that atleast 4 lines are below the HR
         \needspace{((( min_header_lines )))\baselineskip}
 
         % Add a horizantal break, along with break title.
         \vspace{10pt}
         {\scriptsize Input}\\*
         \rule[10pt]{\linewidth}{0.5pt}
         \vspace{-25pt}
 
         % Add contents below.
         ((( cell.input | highlight )))
         
     ((* elif resources.sphinx.outputstyle == 'notebook' *))
-        \begin{ColorVerbatim}[\textbf{In {[}((( cell.prompt_number ))){]}:}]
+        \textbf{In {[}((( cell.prompt_number ))){]}:}\\*
+        \vspace{-2.4\baselineskip}
+        \begin{ColorVerbatim}
             ((( cell.input | highlight )))
         \end{ColorVerbatim}
     ((* endif *))
 ((* endblock input *))
 
 %==============================================================================
 % Output_Group
 %
 % Purpose: Make sure that only one header bar only attaches to the output 
 %          once.  By keeping track of when an input group is started
 %==============================================================================
 ((* block output_group *))
     ((* if resources.sphinx.outputstyle == 'simple' *))
         
         % If the first block is an image, minipage the image.  Else
         % request a certain amount of space for the input text.
         ((( iff_figure(cell.outputs[0], "\\begin{minipage}{1.0\\textwidth}", "\\needspace{"  ~ min_header_lines ~ "\\baselineskip}") )))
         
         % Add a horizantal break, along with break title.
         \vspace{10pt}
         {\scriptsize Output}\\*
         \rule[10pt]{\linewidth}{0.5pt}
         \vspace{-20pt}
 
         % Add the contents of the first block.
         ((( render_output(cell.outputs[0]) )))
 
         % Close the minipage.
         ((( iff_figure(cell.outputs[0], "\\end{minipage}", "") )))
 
         % Add remainer of the document contents below.
         ((* for output in cell.outputs[1:] *))
             ((( render_output(output) )))
         ((* endfor *))
     ((* elif resources.sphinx.outputstyle == 'notebook' *))
         
-        % Add remainer of the document contents below.
+        %Skip one line down.
+        \vspace{1\baselineskip}
+        
+        % Add document contents.
+        \begin{ColorVerbatim}
         ((* for output in cell.outputs *))
             ((( render_output(output) )))
         ((* endfor *))
+        \end{ColorVerbatim}
     ((* endif *))
 ((* endblock *))
 
 %==============================================================================
 % Additional formating
 %==============================================================================
 ((* block data_text *))
     ((( custom_verbatim(output.text) )))
 ((* endblock *))
 
 ((* block traceback_line *))
     ((( line | indent| rm_ansi )))
 ((* endblock traceback_line *))
 
 %==============================================================================
 % Supported image formats
 %==============================================================================
 ((*- block data_png -*))
     ((( insert_graphics(output.key_png) )))
 ((*- endblock -*))
 
 ((*- block data_svg -*))
     ((( insert_graphics(output.key_svg) )))
 ((*- endblock -*))
 
 %==============================================================================
 % Support Macros
 %==============================================================================
 
 % Name: render_output
 % Purpose: Renders an output block appropriately.
 ((* macro render_output(output) -*))
     ((*- if output.output_type == 'pyout' -*))
         ((*- block pyout scoped -*))
             ((( custom_verbatim(super()) )))
         ((*- endblock pyout -*))
     ((*- elif output.output_type == 'stream' -*))
         ((*- block stream scoped -*))
            ((( custom_verbatim(output.text) ))) 
         ((*- endblock stream -*))
     ((*- elif output.output_type == 'display_data' -*))
         ((*- block display_data scoped -*))
             ((( super() )))
         ((*- endblock display_data -*))
     ((*- elif output.output_type == 'pyerr' -*))
         ((*- block pyerr scoped -*))
             ((( custom_verbatim(super()) )))
         ((*- endblock pyerr -*))
     ((*- endif -*))
 ((*- endmacro *))
 
 % Name: iff_figure
 % Purpose: If the output block provided is a figure type, the 'true_content'
 %          parameter will be returned.  Else, the 'false_content'. 
 ((* macro iff_figure(output, true_content, false_content) -*))
     ((* if output.output_type in ['display_data'] -*))
         ((( true_content )))
     ((*- else -*))
         ((( false_content )))
     ((*- endif *))
 ((*- endmacro *))
 
 % Name: custom_verbatim
 % Purpose: This macro creates a verbatim style block that fits the existing
 %          sphinx style more readily than standard verbatim blocks.
 ((* macro custom_verbatim(text) -*))
-
+    ((* if resources.sphinx.outputstyle == 'simple' *))
     \begin{lstlisting}
 ((( text | wrap(wrap_size) )))
     \end{lstlisting}
-    
+    ((* elif resources.sphinx.outputstyle == 'notebook' *))
+    \begin{alltt}
+((( text | wrap(wrap_size) )))
+    \end{alltt}
+    ((* endif *))
 ((*- endmacro *))
 
 % Name: insert_graphics
 % Purpose: This macro will insert an image in the latex document given a path.
 ((* macro insert_graphics(path) -*))
     \begin{center}
     \includegraphics[width=0.7\textwidth]{(((path)))}
     \par
     \end{center}
 ((*- endmacro *))
 
 % Name: escape_underscores
 % Purpose: Underscores cause a problem in latex.  It's important that we 
 %          escape any underscores that appear.
 ((* macro escape_underscores(text) -*))
     ((*- set text = text|replace("_","\\_") -*))
     ((( text )))
 ((*- endmacro *))