drasil-gen-0.1.3.0: A framework for code and document generation for scientific software - Utils SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.Generator.Formats

Description

Defines output formats for the different documents we can generate.

Synopsis

Types (Printing Options)

data DocSpec Source #

Document specifications. Holds the type of document (DocType) and its name (Filename).

Constructors

DocSpec Format Filename 

type Filename = String Source #

When choosing your document, you must specify the filename for the generated output (specified without a file extension).

data Format Source #

Possible formats for printer output.

Constructors

TeX 
HTML 
Jupyter 
MDBook 

Instances

Instances details
Show Format Source # 
Instance details

Defined in Drasil.Generator.Formats

Methods

showsPrec :: Int -> Format -> ShowS #

show :: Format -> String #

showList :: [Format] -> ShowS #

Rules

buildMakefile :: DocSpec -> Maybe Makefile Source #

Create a Makefile necessary for building a DocSpec when rendered as a concrete artifact. Only relevant to TeX and MDBook.