-
Notifications
You must be signed in to change notification settings - Fork 841
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
Build haddocks for dependencies #143
Comments
@manny-fp I think you've done most of the Haddock work, what do you think about this? |
This makes sense to me (I'd like the same kinds of things). |
It might also make sense to add an option to just build the Haddocks for local packages mentioned in stack.yaml? The use-case I have in mind would be to build documentation for locally developed code on a CI server and upload it somewhere. |
@taladar That's currently how Question for everyone: should the default be to build haddocks for only local packages, or should the default be to build haddocks for all dependencies? |
Good question, this is also relevant for providing an eventual |
Another question: for dependencies installed in
The same question also applies to linking to docs for the standard libraries included with GHC. I lean toward (3), as this makes for consistent links and makes the documentation easy to copy to a web server or otherwise move around. |
And another question: should
Also, would a "master index" containing all packages installed in |
q1
I think the default should be to build the doc for all dependecies
q2
I vote for 3 ( links to ../package/) too because :
q3
I would lean toward 4. : both (2) and (3) q4
yes 👍 Main vision around doc
|
Option 1 or 3 seems pretty good.
Under |
edit: this answered a different question, I thought @chrisdone was asking about the "master index" for all dependencies. It would be under In all this, I'm also thinking about optionally generating hoogle databases along the way, so I think the above would be especially useful for being able to hoogle a big set of packages locally. In the case of using a Docker image with all Stackage packages preinstalled, it would give you a way to locally hoogle all of Stackage. |
@chrisdone Oh sorry, I answered the wrong question there! To answer your actual question, YES, it would be in |
just updated my opinion with more arguments and clarity |
@rvion happy to say that we share basically the same vision |
Build haddocks for dependencies (#143)
I believe this is fully implemented, closing. Please reopen otherwise. |
* master: Generate indexes for all deps and all installed snapshot packages (#143) Move windows-only failure in Stack.Iface to runtime instead of compile time Set lower dependency restrictions on project-template.
From what I see, haddocks aren't built when installing dependencies.
It would be nice to support these use cases:
stack haddock
and have it build the haddocks for the dependencies (without rebuilding them, of course). In other words, be able to build haddocks on demand.The text was updated successfully, but these errors were encountered: