Add an extra-html-docs field for the Simple build type #1167

Closed
jwiegley opened this Issue Jan 5, 2013 · 1 comment

Projects

None yet

3 participants

@jwiegley

Right now there is no way to associate custom images with Haddock documentation (such as the lens package does) without having to rely on an external server. What I would like is a way to indicate that certain files and/or directories provide "extra HTML" and should be copied straight over to the the doc/html directory. This way Haddock can link to those docs. For this I propose "extra-html-docs". Such extra docs would also be copied into the source tarball made by "sdist".

@byorgey
Haskell member

+1 from me! This sounds like a great, simple solution. Seems like it shouldn't be too hard to implement, either...

@23Skidoo 23Skidoo pushed a commit that closed this issue Feb 6, 2013
John Wiegley Add extra-html-files, for installing extra html files
For example, you might have an images/ directory in your project, with
images that you refer to from Haddock with:

    <<images/foo.png>>

Then in your Cabal file you would include:

    extra-html-files: images/*.png

And these would both be packaged by sdist, and "cabal haddock" will
install them in:

    ~/.cabal/share/doc/PROJECT/html/images/*.png

Fixes #1167
49a2be9
@23Skidoo 23Skidoo closed this in 49a2be9 Feb 6, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment