看来您可以从 Maven 插件项目生成标准文档网站(例如这个)。我尝试mvn site
在插件项目中执行,但它没有生成预期的文档(显示 Mojo 目标、参数等的页面)。是否必须调用其他目标来生成这些网页?我正在使用 Maven v. 2.1.0。
4 回答
开箱即用,mvn site
至少应该生成一个索引页面(并利用项目name
的description
POM)和一组基本报告(关于、问题跟踪、项目团队、依赖项、项目插件、持续集成、源存储库、项目许可证、邮件列表、插件管理、项目摘要)。
如果您想自定义报告集,您可以配置Maven 项目信息报告插件(在该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>
如果要自定义站点,则需要提供站点描述符(src/site/site.xml
默认情况下)。在这种情况下,您必须<menu ref="reports"/>
为上述报告添加一个条目。
如果您想添加内容,您必须使用一种受支持的格式(例如 APT、FML、XDoc)来提供它。大多数时候,现在使用APT 。
查看Maven 站点插件的文档以获取更多详细信息。
为了获取站点文档中包含的插件文档(目标、参数等),您需要将以下内容添加到 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 等效项。
它不产生任何东西?那会很奇怪,它至少应该构建一个非常基本的站点,其中包含一般信息和依赖项文档。maven site
是正确的电话。
对于其他文档(javadoc、测试报告等),您需要向构建文件添加更多元素。查看一些示例的 surefire 插件文档。
不,但您的项目应包含此处所示的特定结构。