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.


Properties

Versions0.1.0.0, 0.1.1.0, 0.1.2.0
Dependenciesbase (==4.6.*), Cabal (==1.16.*), containers (==0.5.*), directory (==1.2.*), filepath (==1.3.*), superdoc
LicenseBSD3
CopyrightCopyright (c) 2013-2014 Peter Selinger
AuthorPeter Selinger
Maintainerselinger@mathstat.dal.ca
CategoryDistribution
Home pagehttp://www.mathstat.dal.ca/~selinger/superdoc/
Executablessuperdoc-armor
Upload dateThu Feb 13 03:59:29 UTC 2014
Uploaded byPeterSelinger
Downloads289 total (28 in last 30 days)

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees