Ticket #125 (closed enhancement: fixed)

Opened 6 years ago

Last modified 6 years ago

running Haddock with different options not possible

Reported by: g9ks157k@… Owned by: ijones
Priority: normal Milestone:
Component: Cabal library Version: 1.1.6
Severity: normal Keywords:
Cc: Difficulty: normal
GHC Version: 6.6 Platform: Linux

Description

When using Distribution.Simple, Haddock can only be run with default options. It is, for example, not possible to generate different flavors of documentation—an API documentation and a documentation with --ignore-all-exports, for instance.

Change History

Changed 6 years ago by duncan

There is now a configure --haddock-options flag that passes extra flags to haddock. Does this help at all?

Changed 6 years ago by g9ks157k@…

This does help, indeed.

However, there is a related problem. If I want to build a documentation for developers which exposes all private things, it is not enough to run Haddock with --ignore-all-exports. Cabal has to run Haddock on all modules of the package, not just the modules which are exposed. Could such a feature be implemented as well?

Changed 6 years ago by ross@…

Cabal already runs haddock over all the modules, but it adds --hide options for the other modules. It would certainly be possible to add an option to turn that off.

Changed 6 years ago by duncan

So can we open a new bug for that feature request and close this bug now?

Changed 6 years ago by ross@…

  • status changed from new to closed
  • resolution set to fixed

new request opened as #156

Note: See TracTickets for help on using tickets.