Cabal: local documentation - Haskell-Cafe - Haskell.org

newer
[Colin Paul Adams] Re:...

Cabal: local documentation

older
The community is more important...

Martijn van Steenbergen

24 Feb 2009 24 Feb '09

10:33 a.m.

Hello, Can cabal automatically generate local documentation for packages I install? It'd be awesome if it generated a page like [1] for locally installed packages. Thanks, Martijn. [1] http://www.haskell.org/ghc/dist/current/docs/libraries/

Reply

Sign in to reply online Use email software

Show replies by date

Felipe Lessa

24 Feb 24 Feb

10:39 a.m.

Just pass '--enable-documentation' to 'cabal install'. On *nix they're generated at ~/.cabal/share/doc. HTH, -- Felipe.

Reply

Sign in to reply online Use email software

Svein Ove Aas

11:42 a.m.

2009/2/24 Felipe Lessa :

Just pass '--enable-documentation' to 'cabal install'. On *nix they're generated at ~/.cabal/share/doc.

Or edit ~/.cabal/config and set the documentation key to True

Reply

Sign in to reply online Use email software

Duncan Coutts

7:13 p.m.

On Tue, 2009-02-24 at 17:42 +0100, Svein Ove Aas wrote:

2009/2/24 Felipe Lessa :

...
Just pass '--enable-documentation' to 'cabal install'. On *nix they're generated at ~/.cabal/share/doc.

Or edit ~/.cabal/config and set the documentation key to True

However this does not maintain a complete module index like I think Martijn is after. It would be great if someone volunteered to implement that. There's a ticket open for it: http://hackage.haskell.org/trac/hackage/ticket/206 One question is where to put a central index. This is especially true for the case of global installations. For per-user installs it's probably fine to use ~/.cabal/share/doc/index.html or something, but for the case of /usr/local that's certainly not ok. Needs some thought. Duncan

Reply

Sign in to reply online Use email software

Martijn van Steenbergen

25 Feb 25 Feb

8:29 a.m.

Duncan Coutts wrote:

On Tue, 2009-02-24 at 17:42 +0100, Svein Ove Aas wrote:

...
2009/2/24 Felipe Lessa :

...
Just pass '--enable-documentation' to 'cabal install'. On *nix they're generated at ~/.cabal/share/doc.

Or edit ~/.cabal/config and set the documentation key to True

However this does not maintain a complete module index like I think Martijn is after.

Thank you all for the very helpful suggestions. I edited ~/.cabal/config to generate documentation by default, and I set up Apache to serve the documentation from http://haddock. I put a small PHP (gasp!) file in ~/.cabal/share/doc that lists all packages for which there is documentation; see below. This is a good enough approximation for now. Thanks again! Martijn. --- <html> <head> <title>Local Hackage packages</title> </head> <body> <h1>Local Hackage packages</h1> <ul> <? $handle = opendir(dirname(__FILE__)); while (false !== ($pkg = readdir($handle))) { if ($pkg == "." || $pkg == "..") continue; $link = "$pkg/html/"; if (file_exists("${link}index.html")) { echo '<li><a href="' . $link . '">' . $pkg . '</a></li>' . "\n"; } } ?> </ul> </body> </html>

Reply

Sign in to reply online Use email software

5930

Age (days ago)

5931

Last active (days ago)

Download

4 comments

4 participants

tags

participants (4)

Duncan Coutts
Felipe Lessa
Martijn van Steenbergen
Svein Ove Aas