Come includere obiettivi e parametri di documentazione per un sito plugin di Maven

Question

Sembra che che si può generare un sito web di documentazione standard (come questo uno ) da un progetto plugin di Maven. Ho provato l'esecuzione di mvn site in un progetto di plug-in, ma non genera la documentazione prevista (una pagina che mostra il Mojo obiettivi, parametri, ecc). C'è qualche altro obiettivo che deve essere invocato per generare queste pagine web? Sto usando Maven v. 2.1.0.

Answer 1

Al fine di ottenere la documentazione plug-in (obiettivi, params, etc.) inclusi nella documentazione del sito, è necessario aggiungere quanto segue alla pom.xml

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-plugin</artifactId>
        <version>2.5.1</version>
      </plugin>
    </plugins>
  </reporting>    
  ...
</project>

Questo aggiunge un link "relazioni di progetto" al menu del sito, che mostra il plugin Maven equivalente di Javadoc.

Answer 2

Fuori dalla scatola, mvn site dovrebbe almeno generare una pagina di indice (e l'effetto leva del name e la descriptionfrom POM del progetto) e un set di base di rapporti (A proposito, Issue Tracking, Project Team, Dipendenze, progetto Plugin, Continuous Integration, repository di origine, Project Licenza, mailing list, Plugin di gestione, Project Summary).

Se si desidera personalizzare il set di report, è possibile configurare la Maven Progetto Info Reports Plugin (nella sezione reporting) per includere solo i report che si desidera:

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.2</version>
        <reportSets>
          <reportSet>
            <reports>
              <report>dependencies</report>
              <report>project-team</report>
              <report>mailing-list</report>
              <report>cim</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

Se si desidera personalizzare il sito, è necessario fornire un sito descrittore (src/site/site.xml per impostazione predefinita). In tal caso, si dovrà includere una voce <menu ref="reports"/> per le relazioni di cui sopra.

Se desideri aggiungere contenuti , dovrete fornire utilizzando uno dei formati supportati (ad esempio, APT, FML, xdoc). La maggior parte del tempo, APT è usato al giorno d'oggi.

controllare la documentazione del Maven Plugin Site per ulteriori dettagli.

Answer 3

Non genera nulla? Che sarebbe strano, si dovrebbe almeno costruire un sito molto semplice con informazioni di carattere generale e la documentazione delle dipendenze. maven siteis la chiamata giusta.

Per documenti aggiuntivi (javadoc, rapporti di prova, ecc) è necessario aggiungere altri elementi al file build. Dai un'occhiata al infallibile plugin di documentazione per alcuni esempi.

Answer 4

No, ma il progetto deve contenere una struttura specifica, come mostrato qui .