Как включить цели и параметры в документации для сайта плагинов Maven

Question

Похоже, что вы можете генерировать стандартную документацию веб-сайт (например, Вот этот) из проекта плагина Maven. Я пытался выполнять mvn site В проекте плагина, но не генерирует ожидаемую документацию (страница, которая показывает цели MOJO, параметры и т. Д.). Есть ли какая-то другая цель, которая должна быть вызвана для создания этих веб-страниц? Я использую Maven v. 2.1.0.

Answer 1

Чтобы получить документацию плагина (цели, параметры и т. Д.), включенные в документацию сайта, вам нужно добавить следующее в 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 2

Из коробки, 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). Большая часть времени, Доп используется в наши дни.

Проверьте документацию о Maven сайт плагин Больше подробностей.

Answer 3

Это ничего не генерирует? Это было бы странно, он должен, по крайней мере, построить очень базовый участок с общей информацией и документацией зависимостей. maven siteэто правильный звонок.

Для дополнительных документов (JavadoC, тестовые отчеты и т. Д.) Вам необходимо добавить больше элементов в файл сборки. Посмотрите на документацию Weansfire Plugin для некоторых примеров.

Answer 4

Нет, но ваш проект должен содержать определенную структуру, как показано здесь.