latex.py
91 lines
| 3.4 KiB
| text/x-python
|
PythonLexer
|
r10677 | """ | ||
Exporter that allows Latex Jinja templates to work. Contains logic to | ||||
appropriately prepare IPYNB files for export to LaTeX. Including but | ||||
not limited to escaping LaTeX, fixing math region tags, using special | ||||
tags to circumvent Jinja/Latex syntax conflicts. | ||||
""" | ||||
|
r10479 | #----------------------------------------------------------------------------- | ||
# Copyright (c) 2013, the IPython Development Team. | ||||
# | ||||
# Distributed under the terms of the Modified BSD License. | ||||
# | ||||
# The full license is in the file COPYING.txt, distributed with this software. | ||||
#----------------------------------------------------------------------------- | ||||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
|
r10585 | |||
|
r11203 | # Stdlib imports | ||
import os | ||||
|
r10585 | # IPython imports | ||
|
r11383 | from IPython.utils.traitlets import Unicode, List | ||
|
r10872 | from IPython.config import Config | ||
|
r10585 | |||
|
r11089 | from IPython.nbconvert import filters, transformers | ||
from .exporter import Exporter | ||||
|
r10677 | |||
|
r10479 | #----------------------------------------------------------------------------- | ||
# Classes and functions | ||||
#----------------------------------------------------------------------------- | ||||
|
r11089 | class LatexExporter(Exporter): | ||
|
r10677 | """ | ||
Exports to a Latex template. Inherit from this class if your template is | ||||
LaTeX based and you need custom tranformers/filters. Inherit from it if | ||||
you are writing your own HTML template and need custom tranformers/filters. | ||||
If you don't need custom tranformers/filters, just change the | ||||
'template_file' config option. Place your template in the special "/latex" | ||||
subfolder of the "../templates" folder. | ||||
""" | ||||
|
r10624 | file_extension = Unicode( | ||
'tex', config=True, | ||||
help="Extension of the file that should be written to disk") | ||||
|
r10479 | |||
|
r11733 | flavor = Unicode('article', config=True, help="""Flavor of the data format to | ||
use. I.E. 'full' or 'basic'""") | ||||
|
r10690 | |||
#Latex constants | ||||
|
r11648 | default_template_path = Unicode( | ||
|
r11191 | os.path.join("..", "templates", "latex"), config=True, | ||
|
r10690 | help="Path where the template files are located.") | ||
template_skeleton_path = Unicode( | ||||
|
r11191 | os.path.join("..", "templates", "latex", "skeleton"), config=True, | ||
|
r10690 | help="Path where the template skeleton files are located.") | ||
#Special Jinja2 syntax that will not conflict when exporting latex. | ||||
jinja_comment_block_start = Unicode("((=", config=True) | ||||
jinja_comment_block_end = Unicode("=))", config=True) | ||||
jinja_variable_block_start = Unicode("(((", config=True) | ||||
jinja_variable_block_end = Unicode(")))", config=True) | ||||
jinja_logic_block_start = Unicode("((*", config=True) | ||||
jinja_logic_block_end = Unicode("*))", config=True) | ||||
#Extension that the template files use. | ||||
template_extension = Unicode(".tplx", config=True) | ||||
|
r10869 | |||
|
r11733 | |||
|
r10963 | @property | ||
def default_config(self): | ||||
c = Config({ | ||||
|
r11419 | 'NbConvertBase': { | ||
|
r11573 | 'display_data_priority' : ['latex', 'pdf', 'png', 'jpg', 'svg', 'jpeg', 'text'] | ||
|
r10965 | }, | ||
|
r11634 | 'ExtractOutputTransformer': { | ||
|
r11367 | 'enabled':True | ||
|
r11383 | }, | ||
|
r11422 | 'SVG2PDFTransformer': { | ||
|
r11383 | 'enabled':True | ||
}, | ||||
'LatexTransformer': { | ||||
'enabled':True | ||||
|
r11736 | }, | ||
|
r11733 | 'SphinxTransformer': { | ||
'enabled':True | ||||
} | ||||
|
r10963 | }) | ||
c.merge(super(LatexExporter,self).default_config) | ||||
return c | ||||