On Fri, Mar 20, 2015 at 12:16 PM, dan bress <danbr...@gmail.com> wrote:
> Maven,
>    I have a multi module maven project and am trying to generate an
> assembly that houses all our javadocs and our asciidoc generated docs.  How
> would you do this?
>
> Currently I have a directory structure that looks like this:
>
> root
>   java-library-one
>   java-library-two
>   ascidoc-project
>   pom.xml
>
> If I put a javadoc:aggregate plugin execution on the root pom it generates
> the javadoc for both of my projects, which is what I want.  But I am not
> sure where to put my assembly.  Should that be called from the root pom?
> Should I make a sub project for the assembly?  If I do that, can it refer
> to the javadoc generated by the parent?
>
> Let me know what you think!
> Thanks!

I've done something like this in the past. It's not pretty, but
essentially, I had a sub-module for "docs", which, in its package
phase, would bundle the javadocs created by the parent. To get this to
work, I would have to run:

mvn compile javadoc:aggregate package

This would essentially force 3 lifecycles, the first to compile and
the second to build the javadocs (which requires compilation first),
and the third to package. Incidentally, the third lifecycle would end
up compiling again, which was a bit of a waste, but it did work.

In general, I'd avoid trying to bundle all the javadocs... partly
because this is messy, and partly because I don't see a lot of value
in a deployable artifact which bundles all the javadocs from many
modules. Currently, my project only bundles individual javadoc jars to
deploy to maven, and no longer builds an artifact with the aggregated
javadocs. We still occasionally run javadoc:aggregate, though to
generate docs to publish.

--
Christopher L Tubbs II
http://gravatar.com/ctubbsii

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
For additional commands, e-mail: users-h...@maven.apache.org

Reply via email to