You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
82 lines
2.7 KiB
Python
82 lines
2.7 KiB
Python
"""Module that allows latex output notebooks to be conditioned before
|
|
they are converted.
|
|
"""
|
|
# -----------------------------------------------------------------------------
|
|
# 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
|
|
# -----------------------------------------------------------------------------
|
|
|
|
from traitlets import List, Unicode
|
|
|
|
from .base import Preprocessor
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Classes
|
|
# -----------------------------------------------------------------------------
|
|
|
|
|
|
class LatexPreprocessor(Preprocessor):
|
|
"""Preprocessor for latex destined documents.
|
|
|
|
Populates the ``latex`` key in the resources dict,
|
|
adding definitions for pygments highlight styles.
|
|
|
|
Sets the authors, date and title of the latex document,
|
|
overriding the values given in the metadata.
|
|
"""
|
|
|
|
date = Unicode(
|
|
None,
|
|
help=("Date of the LaTeX document"),
|
|
allow_none=True,
|
|
).tag(config=True)
|
|
|
|
title = Unicode(None, help=("Title of the LaTeX document"), allow_none=True).tag(config=True)
|
|
|
|
author_names = List(
|
|
Unicode(),
|
|
default_value=None,
|
|
help=("Author names to list in the LaTeX document"),
|
|
allow_none=True,
|
|
).tag(config=True)
|
|
|
|
style = Unicode("default", help="Name of the pygments style to use").tag(config=True)
|
|
|
|
def preprocess(self, nb, resources):
|
|
"""Preprocessing to apply on each notebook.
|
|
|
|
Parameters
|
|
----------
|
|
nb : NotebookNode
|
|
Notebook being converted
|
|
resources : dictionary
|
|
Additional resources used in the conversion process. Allows
|
|
preprocessors to pass variables into the Jinja engine.
|
|
"""
|
|
# Generate Pygments definitions for Latex
|
|
from pygments.formatters import LatexFormatter
|
|
|
|
resources.setdefault("latex", {})
|
|
resources["latex"].setdefault(
|
|
"pygments_definitions", LatexFormatter(style=self.style).get_style_defs()
|
|
)
|
|
resources["latex"].setdefault("pygments_style_name", self.style)
|
|
|
|
if self.author_names is not None:
|
|
nb.metadata["authors"] = [{"name": author} for author in self.author_names]
|
|
|
|
if self.date is not None:
|
|
nb.metadata["date"] = self.date
|
|
|
|
if self.title is not None:
|
|
nb.metadata["title"] = self.title
|
|
|
|
return nb, resources
|