The superdoc package

[Tags: bsd3, library, program]

This package extends Cabal's documentation building capabilities. It extends the Haddock markup language with syntax for subscripts, superscripts, bold text, non-breaking spaces, and images. Moreover, it works around various bugs in Haddock's and HsColour's Unicode support, making it possible to use UTF8 encodings in both source code and documentation comments.

This package is designed to work transparently. It provides a custom main function that package maintainers can use in their Setup.hs file. In most cases, this is as simple as setting the build-type to Custom, adding superdoc to the package dependencies, and putting the following two lines into Setup.hs:

 import Distribution.Superdoc
 main = superdocMain

For more information on the available markup, see Distribution.Superdoc.


Dependenciesbase (>=4.6 && <4.8), Cabal (>=1.16), containers (==0.5.*), directory (==1.2.*), filepath (==1.3.*), superdoc
CopyrightCopyright (c) 2013-2014 Peter Selinger
AuthorPeter Selinger
Home page
UploadedWed Oct 8 03:38:29 UTC 2014 by PeterSelinger
Downloads687 total (65 in last 30 days)
StatusDocs uploaded by user
Build status unknown [no reports yet]




Maintainers' corner

For package maintainers and hackage trustees