Text.Pandoc.Filter.Pyplot

This module defines a Pandoc filter makePlot that can be used to walk over a Pandoc document and generate figures from Python code blocks.

Documentation

makePlot :: Block -> IO Block

Highest-level function that can be walked over a Pandoc tree. All code blocks that have the plot_target parameter will be considered figures.

makePlot' :: Block -> IO (Either PandocPyplotError Block)

Main routine to include Matplotlib plots. Code blocks containing the attributes plot_target are considered Python plotting scripts. All other possible blocks are ignored. The source code is also saved in another file, which can be access by clicking the image

plotTransform :: Pandoc -> IO Pandoc

Walk over an entire Pandoc document, changing appropriate code blocks into figures.

data PandocPyplotError

Possible errors returned by the filter

Constructors

ScriptError Int

Running Python script has yielded an error

InvalidTargetError FilePath

Invalid figure path

MissingDirectoryError FilePath

Directory where to save figure does not exist

BlockingCallError

Python script contains a block call to 'show()'

showError :: PandocPyplotError -> String

Translate filter error to an error message