Dhall.Docs.Core

Contains all the functions that generate documentation

We should always try to do as little work as possible in an IO context. To do so, just wrap your function in IO if you need to do I/O operations, and make pure functions receive that IO result as an input

Documentation

generateDocs

Arguments

:: Path Abs Dir

Input directory

-> Path Abs Dir

Link to be created to the generated documentation

-> Text

Package name, used in some HTML titles

-> IO ()

Generate all of the docs for a package. This function does all the `IO ()` related tasks to call generateDocsPure

generateDocsPure

Arguments

:: Text

Package name

-> [(Path Rel File, Text)]

(Input file, contents)

-> GeneratedDocs [(Path Rel File, Text)]

Generates all the documentation of dhall package in a pure way i.e. without an IO context. This let you generate documentation from a list of dhall-files without saving them to the filesystem.

If you want the IO version of this function, check generateDocs

data GeneratedDocs a

The result of the doc-generator pure component

Constructors

GeneratedDocs [DocsGenWarning] a

Instances

Monad GeneratedDocs

Defined in Dhall.Docs.Core

Methods

(>>=) :: GeneratedDocs a -> (a -> GeneratedDocs b) -> GeneratedDocs b

(>>) :: GeneratedDocs a -> GeneratedDocs b -> GeneratedDocs b

return :: a -> GeneratedDocs a

fail :: String -> GeneratedDocs a

Functor GeneratedDocs

Defined in Dhall.Docs.Core

Methods

fmap :: (a -> b) -> GeneratedDocs a -> GeneratedDocs b

(<$) :: a -> GeneratedDocs b -> GeneratedDocs a

Applicative GeneratedDocs

Defined in Dhall.Docs.Core

Methods

pure :: a -> GeneratedDocs a

(<*>) :: GeneratedDocs (a -> b) -> GeneratedDocs a -> GeneratedDocs b

liftA2 :: (a -> b -> c) -> GeneratedDocs a -> GeneratedDocs b -> GeneratedDocs c

(*>) :: GeneratedDocs a -> GeneratedDocs b -> GeneratedDocs b

(<*) :: GeneratedDocs a -> GeneratedDocs b -> GeneratedDocs a