@Mojo(name="site", requiresDependencyResolution=TEST, requiresReports=true) public class SiteMojo extends AbstractSiteRenderingMojo
Note that links between module sites in a multi module build will not work, since local build directory structure doesn't match deployed site.
Modifier and Type | Field and Description |
---|---|
private boolean |
generateReports
Convenience parameter that allows you to disable report generation.
|
private boolean |
generateSitemap
Generate a sitemap.
|
protected java.io.File |
outputDirectory
Directory where the project sites and report distributions will be generated.
|
private boolean |
validate
Whether to validate xml input documents.
|
generatedSiteDirectory, mavenSession, reports, siteRenderer
repositories, siteDirectory
i18n, localRepository, project, reactorProjects, siteTool, skip
Constructor and Description |
---|
SiteMojo() |
Modifier and Type | Method and Description |
---|---|
void |
execute()
Generate the project site
throws MojoExecutionException if any
|
private java.io.File |
getOutputDirectory(java.util.Locale locale) |
org.apache.maven.project.MavenProject |
getProject() |
org.apache.maven.execution.MavenSession |
getSession() |
private java.util.List<org.apache.maven.doxia.siterenderer.DocumentRenderer> |
renderDoxiaDocuments(java.util.Map<java.lang.String,org.apache.maven.doxia.siterenderer.DocumentRenderer> documents,
org.apache.maven.doxia.siterenderer.SiteRenderingContext context,
java.io.File outputDir,
boolean generated)
Render Doxia documents from the list given, but not reports.
|
private void |
renderLocale(java.util.Locale locale,
java.util.List<org.apache.maven.reporting.exec.MavenReportExecution> reports) |
categoriseReports, checkInputEncoding, contextualize, createSiteRenderingContext, getInputEncoding, getOutputEncoding, getReports, locateDocuments, locateReports, populateReportItems
prepareDecorationModel
getLocales, getMavenVersion, isMaven3OrMore
@Parameter(property="siteOutputDirectory", defaultValue="${project.reporting.outputDirectory}") protected java.io.File outputDirectory
@Parameter(property="generateReports", defaultValue="true") private boolean generateReports
@Parameter(property="generateSitemap", defaultValue="false") private boolean generateSitemap
@Parameter(property="validate", defaultValue="false") private boolean validate
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
Mojo.execute()
private void renderLocale(java.util.Locale locale, java.util.List<org.apache.maven.reporting.exec.MavenReportExecution> reports) throws java.io.IOException, org.apache.maven.doxia.siterenderer.RendererException, org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
java.io.IOException
org.apache.maven.doxia.siterenderer.RendererException
org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
private java.util.List<org.apache.maven.doxia.siterenderer.DocumentRenderer> renderDoxiaDocuments(java.util.Map<java.lang.String,org.apache.maven.doxia.siterenderer.DocumentRenderer> documents, org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.io.File outputDir, boolean generated) throws org.apache.maven.doxia.siterenderer.RendererException, java.io.IOException
documents
- a collection of documents containing both Doxia source files and reportsorg.apache.maven.doxia.siterenderer.RendererException
java.io.IOException
private java.io.File getOutputDirectory(java.util.Locale locale)
public org.apache.maven.project.MavenProject getProject()
public org.apache.maven.execution.MavenSession getSession()