Home » Enterprise Java » Maven » How to generate a documentation site for your Maven based project example

About Sotirios-Efstathios Maneas

Sotirios-Efstathios Maneas
Sotirios-Efstathios (Stathis) Maneas is a PhD student at the Department of Computer Science at the University of Toronto. His main interests include distributed systems, storage systems, file systems, and operating systems.

How to generate a documentation site for your Maven based project example

In this tutorial, we will show you an easy way to generate a documentation site for your project, using Apache Maven.
 
In this example, we use the following tools on a Windows 7 platform:

  • Apache Maven 3.1.1
  • JDK 1.7

In order to generate the documentation site for our Maven project, we must first navigate to its folder, using the terminal (Linux or Mac) or the command prompt (Windows). Then, we must issue the following command:

mvn site

A sample output of the command is shown below:

mvn_site_cmd_WM

All generated files are placed into the folder target/site. A list of all generated files is shown below:

mvn_site_files_WM

The project’s information page is shown below:

mvn_site_information_WM

As seen in the following image, our project has the jUnit library declared as dependency:

mvn_site_dependencies_WM
 
 
This was a tutorial on how to generate a documentation site for a project, using Apache Maven.

Do you want to know how to develop your skillset to become a Java Rockstar?

Subscribe to our newsletter to start Rocking right now!

To get you started we give you our best selling eBooks for FREE!

 

1. JPA Mini Book

2. JVM Troubleshooting Guide

3. JUnit Tutorial for Unit Testing

4. Java Annotations Tutorial

5. Java Interview Questions

6. Spring Interview Questions

7. Android UI Design

 

and many more ....

 

 

Want to take your Java skills to the next level?

Grab our programming books for FREE!

Here are some of the eBooks you will get:

  • Spring Interview QnA
  • Multithreading & Concurrency QnA
  • JPA Minibook
  • JVM Troubleshooting Guide
  • Advanced Java
  • Java Interview QnA
  • Java Design Patterns