| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Tintin.Render
Synopsis
- data Render
- perform :: (Has Capability eff, Has Capability eff, Has Capability eff) => BuildTool -> [DocumentationFile] -> Effectful eff [HtmlFile]
- writeOutput :: (Has Capability eff, Has Capability eff) => OutputDirectory -> Info -> Effectful eff ()
- withContext :: [Page] -> [(Page, Context)]
Documentation
perform :: (Has Capability eff, Has Capability eff, Has Capability eff) => BuildTool -> [DocumentationFile] -> Effectful eff [HtmlFile] Source #
writeOutput :: (Has Capability eff, Has Capability eff) => OutputDirectory -> Info -> Effectful eff () Source #
withContext :: [Page] -> [(Page, Context)] Source #
Pair up each page with context (next and previous links) by alphabetical order, excluding index page.
This function is a little more complicated than might be expected because the functionality is a little nuanced. It has to:
- Pair each page with next and previous links based on an alphabetical sorting, excluding the index page.
- Give the first non-index page, alphabetically, a "previous" link pointing to the index if it exists.
- Give the index, if it exists, a "next' link to the first non-index page.