[Haskell-cafe] ANNOUNCE: standalone-haddock-1.0

Mateusz Kowalczyk fuuzetsu at fuuzetsu.co.uk
Sat Jun 8 17:16:54 CEST 2013


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 07/06/13 13:15, Roman Cheplyaka wrote:
> I am happy to announce the first release of standalone-haddock.
> 
> http://feuerbach.github.io/standalone-haddock/
> 
> standalone-haddock generates standalone haddock Haskell
> documentation.
> 
> When you simply run `cabal haddock`, the resulting HTML
> documentation contains hyperlinks to other packages on your system.
> As a result, you cannot publish it on the internet (well, you can,
> but the links will be broken).
> 
> standalone-haddock takes several packages for which you want to
> publish documentation. It generates documentation for them with
> proper links:
> 
> * links to identifiers inside this package set are relative * links
> to identifiers from external packages lead to hackage
> 
> Thus the resulting directory with HTML is relocatable and
> publishable.
> 
> **TL;DR**: it just works. See the [haskell-suite][] documentation
> for an example output.
> 
> [haskell-suite]: http://haskell-suite.github.io/docs [snip]

I could have really used this about 2 days ago. Oh well.

Do you have any idea about how well this will work on all of the GHC
source? That is, are there any known issues that would prevent it from
working or require a special setup?
- -- 
Mateusz K.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.19 (GNU/Linux)

iQIcBAEBAgAGBQJRs0rmAAoJEM1mucMq2pqXFXwP/3y5IPR/6DElHRCKSWkXV5k+
7LaABSTJOVaEWzyI9NqhB47GDMLe8V3GD83/xaKoeVdTobgoYG1PpMWudOA9k05n
BO829mMxqNWS+2s+tgwgEXr0UXerKwCcQDnSvFEFiyhyQo5eaZnDnbjupTJs3ES+
DqdEaQxgf2BSCnzHEtsMH9vqhnduMIRjclMcVHtcKn2PZ4ivGn9Igm6KLc6Cq8U/
lay/geO3rIoFNmlF5RzzDXMT4k2pIeABu/xKTkcdc+zxtQK/G5TD5kYJXM7LhyrK
A8sAHtBISUu00p9MCX08iuFs6cUwW1L8djPpU4dT8kAPRW95BsQVILS28ChOTakv
kZzCRY1UP+GtQ9uAE/xBHPv7EACpzeXeZTAwj2KC/xRkW9zQ5J8IqpQ8m8BsHwhr
uqQoHZR/RytEAEOoHdeR9sOczjawuKEiIfCahuHeClF4qOHWAui2eiFQ58rckF28
kyPd2gfj2w67j1JR2voG4sk3nvcYvdHcAL7no0ZSxjSRJj26SmKB96+Y7jSiJ+d/
Do90mGUaJYTLcgW13shkJ6ZHvco2P9Yq56GR1g9Pd3nbQ5JRUwarUX/bjmeM48u6
skP7+GWgB5XQUeZ3gQ39M5o5NGw7FgySSdMUVvNhisdmQqn1yYzCerFUhwO3uxL4
gBhOR7JWYb9dCaz4V4py
=joYv
-----END PGP SIGNATURE-----



More information about the Haskell-Cafe mailing list