Ticket #115 (new enhancement)

Opened 5 years ago

Last modified 22 months ago

allow putting support files in a relative subdir

Reported by: duncan Owned by:
Priority: major Milestone:
Version: 2.4.2 Keywords:
Cc:

Description

We're adding support in Cabal to maintain an index of all docs installed on the system. The only problem is that we are cluttering the directory with lots of other haddock support files. http://hackage.haskell.org/trac/hackage/ticket/516#comment:1

In the cabal config file we say

doc-index-file: $datadir/doc/index.html

but of course when we call haddock to make the index it generates a bunch of other files in the same directory. This is rather annoying in this use case. Yes we could have the default be something like:

doc-index-file: $datadir/doc/haddock-index/index.html

but since $datadir/doc/ really is the top of the doc tree then it's nice to have the index live there.

What would be ideal is if we could put the index.html file at the top but direct that the support files (css, gif, js) go into a subdirectory relative to the target.

Specifically I'm suggesting something like:

--support-odir=haddock-util

which would then dump the support files into the $odir/haddock-util. The references in the generated html would obviously have to use that relative path to the support files.

This along with being able to suppress the frames output (#114) would make the Cabal haddock index more or less ideal.

Change History

Changed 22 months ago by anonymous

  • milestone 2.5.0 deleted

Milestone 2.5.0 deleted

Note: See TracTickets for help on using tickets.