The superdoc package

[ Tags: bsd3, distribution, library, program ] [ Propose Tags ]

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.


Change log ChangeLog
Dependencies base (>=4.5 && <5), Cabal (>=1.16), containers (>=0.4), directory (>=1.1), filepath (>=1.3), superdoc [details]
License BSD3
Copyright Copyright (c) 2013-2017 Peter Selinger
Author Peter Selinger
Category Distribution
Home page
Uploaded Thu Nov 9 13:39:56 UTC 2017 by PeterSelinger
Distributions NixOS:
Executables superdoc-armor
Downloads 2780 total (61 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI




Maintainer's Corner

For package maintainers and hackage trustees