Как включить цели и параметры в документацию для сайта плагина 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 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 по умолчанию). В этом случае вам нужно будет включить запись <menu ref="reports"/> для вышеуказанных отчетов.

Если вы хотите добавить контент , вам придется предоставить его в одном из поддерживаемых форматов (например, APT, FML, XDoc). В большинстве случаев APT используется в настоящее время.

Более подробную информацию смотрите в документации к плагину Maven Site .

Answer 3

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

Answer 4

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

Для дополнительной документации (javadoc, отчеты о тестировании и т. Д.) Вам необходимо добавить дополнительные элементы в файл сборки. Взгляните на документацию по плагину surefire для некоторых примеров.