maven project documentation

Question

Hi, I have a maven project that has both code and documentation (pdf files). When I create a release of my software, I'd like to package the jar file and the documentation for the user. Is there a "correct" way to do this in maven? Should I have a multiple modules - one for the code (it's a small project, so the code is a single module right now) and one for the documentation? One module for each documentation pdf? Or some other way to package it in a single project? Any help with this would be appreciated.

thanks, Jeff

Answer 1

Take a look at the following post: Creating Documentation With Maven, It could very well answer your question.

Answer 2

When I create a release of my software, I'd like to package the jar file and the documentation for the user. Is there a "correct" way to do this in maven?

I would use the Assembly Plugin to create a zip and/or tar.gz distribution of the project containing both the jar and the various PDFs files.

Should I have a multiple modules - one for the code (it's a small project, so the code is a single module right now) and one for the documentation? One module for each documentation pdf? Or some other way to package it in a single project?

I don't really see the need, I'd keep everything in a single module and put the PDF in src/main/doc or something like that.