Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create offline haddocks including all dependencies, with an index #5383

Open
nomeata opened this Issue Jun 17, 2018 · 3 comments

Comments

Projects
None yet
4 participants
@nomeata
Copy link
Contributor

nomeata commented Jun 17, 2018

I am about to embark on a flight, and I was expecting that a call like

cabal new-haddock

would build the haddock of my current project and all its dependencies (which may not have haddocks yet), and also create a nice index akin to file:///usr/share/doc/ghc-doc/html/libraries/index.html with the haddocks of all visible packages. But it seems that this is not yet supported.

(I am not sure if #3535 is about this, or merely about a technical detail on the road to this feature.)

@sjakobi

This comment has been minimized.

Copy link
Collaborator

sjakobi commented Jul 18, 2018

With the patch from #5395 I can build haddocks including dependency haddocks with

cabal new-haddock --enable-documentation

I don't quite understand why I need to add the --enable-documentation flag but I guess that's a different topic.

@k0001

This comment has been minimized.

Copy link

k0001 commented Oct 1, 2018

Since cabal new-* embraces the idea of multiple packages per project, it would be great if we could have something like standalone-haddock building a top-level documentation for our project encompassing the haddocks for all modules of all the packages in our project.

@ip1981

This comment has been minimized.

Copy link

ip1981 commented Dec 14, 2018

I'm not sure I totally understood you guys, but I miss the feature of creating a haddock documentation for all modules used in project, and I want this documentation in a single directory with all local relative links. So that I could put it in a tarball, publish in Jenkins, etc. I was able to do so with another s-tool ;). There is an option --haddockdir=, but I could find its effect. I'm with Cabal 2.4.0.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.