
* Mateusz Kowalczyk
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?
I imagine it would not be trivial, due to GHC's complicated build system. There's also a known issue that preprocessing doesn't happen (e.g. for alex and happy files) — I hope to fix that soon. Roman