Mavenプラグインサイトのドキュメントに目標とパラメーターを含める方法

StackOverflow https://stackoverflow.com/questions/2912665

質問

標準のドキュメントWebサイトを生成できるように見えます（ これです）Mavenプラグインプロジェクトから。実行してみました mvn site プラグインプロジェクトでは、予想されるドキュメント（Mojoの目標、パラメーターなどを示すページ）を生成しません。これらのWebページを生成するために呼び出さなければならない他の目標はありますか？ Mavenv。2.1.0を使用しています。

役に立ちましたか？

解決 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に相当するものを示しています。

他のヒント

箱から出して、 mvn site 少なくともインデックスページを生成する必要があります（そして、 name そしてその descriptionプロジェクトのPOMから）とレポートの基本セット（問題追跡、プロジェクトチーム、依存関係、プロジェクトプラグイン、継続的統合、ソースリポジトリ、プロジェクトライセンス、メーリングリスト、プラグイン管理、プロジェクトの概要）。

レポートのセットをカスタマイズする場合は、 Maven Project Info Reportsプラグイン （の中に 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 デフォルト）。その場合、aを含める必要があります <menu ref="reports"/> 上記のレポートのエントリ。

あなたがしたい場合は コンテンツを追加します, 、サポートされている形式のいずれかを使用して提供する必要があります（APT、FML、XDOCなど）。ほとんどの場合、 apt 現在使用されています。

のドキュメントを確認してください Mavenサイトプラグイン 詳細については。

何も生成しませんか？それは奇妙なことです。少なくとも、一般的な情報と依存関係のドキュメントを備えた非常に基本的なサイトを構築する必要があります。 maven site正しい呼び出しです。

追加のドキュメント（Javadoc、テストレポートなど）については、ビルドファイルにさらに要素を追加する必要があります。いくつかの例については、SureFireプラグインのドキュメントをご覧ください。

いいえ、しかしあなたのプロジェクトには、示されているように特定の構造が含まれている必要があります ここ.

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top