[Haskell-cafe] Cabal Install & Links to Source from Haddock Docs

[R Hayes]

Is there a way I can get Haddock Docs WITH links to source (local)
from modules installed with "cabal install xxx"?

Getting the docs themselves is pretty easy by changing either ~/.cabal/
config or using --enable-documentation.

Automatically generating the source (colourised or not) and integrated
links eludes me.

-r

[Thomas Hartman]

the answer: not cabal install, just cabal.

***@thartman-laptop:~/haskellInstalls/smallInstalls/pureMD5-0.2.3>
***@thartman-laptop:~/haskellInstalls/smallInstalls/pureMD5-0.2.3>cabal
--help | grep -i doc
haddock Generate Haddock HTML documentation.
***@thartman-laptop:~/haskellInstalls/smallInstalls/pureMD5-0.2.3>cabal
haddock --help | grep -i link
--hyperlink-source Hyperlink the documentation to the source code
***@thartman-laptop:~/haskellInstalls/smallInstalls/pureMD5-0.2.3>cabal
haddock --hyperlink-source

Is there a way I can get Haddock Docs WITH links to source (local) from
modules installed with "cabal install xxx"?
Getting the docs themselves is pretty easy by changing either
~/.cabal/config or using --enable-documentation.
Automatically generating the source (colourised or not) and integrated links
eludes me.
-r
_______________________________________________
Haskell-Cafe mailing list
http://www.haskell.org/mailman/listinfo/haskell-cafe

[R Hayes]

Thank you. As it turns out, I was aware of that recipe. What I
wanted was to be able to use cabal install's nice dependency following
features and still get source links in my documentation.

Personally, I feel that inclusion of source and docs should be the
DEFAULT for cabal, as well as for binary distributions of ghc.

-rhayes

Post by Thomas Hartman
the answer: not cabal install, just cabal.
pureMD5-0.2.3>
pureMD5-0.2.3>cabal
--help | grep -i doc
haddock Generate Haddock HTML documentation.
pureMD5-0.2.3>cabal
haddock --help | grep -i link
--hyperlink-source Hyperlink the documentation to the source code
pureMD5-0.2.3>cabal
haddock --hyperlink-source

Is there a way I can get Haddock Docs WITH links to source (local) from
modules installed with "cabal install xxx"?
Getting the docs themselves is pretty easy by changing either
~/.cabal/config or using --enable-documentation.
Automatically generating the source (colourised or not) and
integrated links
eludes me.
-r
_______________________________________________
Haskell-Cafe mailing list
http://www.haskell.org/mailman/listinfo/haskell-cafe

[Duncan Coutts]

Post by R Hayes
Thank you. As it turns out, I was aware of that recipe. What I
wanted was to be able to use cabal install's nice dependency following
features and still get source links in my documentation.

Due to popular demand we quickly added the --enable-documentation flag
but did not manage to agree a design for exposing the other
haddock/documentation flags via cabal install.

We'd appreciate if you could add your suggestions for the design of the
command line interface to this ticket:

http://hackage.haskell.org/trac/hackage/ticket/206

Post by R Hayes
Personally, I feel that inclusion of source and docs should be the
DEFAULT for cabal, as well as for binary distributions of ghc.

You can set it as a default in the ~/.cabal/config file.

Duncan