Question

您似乎可以从Maven插件项目生成标准文档网站（如this one）。我尝试在插件项目中执行mvn site，但它不会生成预期的文档（显示Mojo目标，参数等的页面）。是否还有一些其他目标必须被调用才能生成这些网页？我正在使用Maven v.2.1.0。

Answer 1

开箱即用，mvn site至少应该生成一个索引页面（并利用项目POM中的name和description）和一组基本报告（关于，问题跟踪，项目团队，依赖关系，项目插件，持续集成，源存储库，项目许可，邮件列表，插件管理，项目摘要）。

如果您要自定义报告集，可以将Maven Project Info Reports Plugin（在reporting部分）配置为仅包含所需的报告：

<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>

如果您想自定义网站，则需要提供site descriptor（默认情况下为src/site/site.xml）。在这种情况下，您必须为上述报告添加<menu ref="reports"/>条目。

如果您想add content，则必须使用支持的格式之一（例如APT，FML，XDoc）提供。大部分时间，APT现在都在使用。

查看Maven Site Plugin的文档以获取更多详细信息。

Answer 2

为了获取站点文档中包含的插件文档（目标，参数等），您需要将以下内容添加到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>

这会在站点菜单中添加一个“项目报告”链接，该链接显示Maven插件相当于Javadoc。

Answer 3

它不会产生任何东西？这很奇怪，它应该至少构建一个非常基本的站点，其中包含一般信息和依赖文档。 maven site是正确的电话。

对于其他文档（javadoc，测试报告等），您需要向构建文件添加更多元素。有关示例，请查看surefire插件文档。

Answer 4

不，但您的项目应包含here所示的特定结构。

如何纳入目标＆amp; maven插件站点文档中的参数

4 个答案: