Преобразование документации программного обеспечения сайта Maven в PDF

Question

В настоящее время я работаю над проектом, написанным на Java, и использую Maven и maven-site-plugin для создания веб-сайта, содержащего все соответствующие JavaDoc, отчеты и т. Д. Мне нужно одновременно, чтобы иметь возможность конвертировать то же самое документация в читабельном, похожем на книгу формате. Существуют ли какие-либо сценарии или инструменты, предназначенные для того, чтобы взять веб-сайт и преобразовать его в разумно отформатированный PDF или другой стиль, чтобы его можно было легко передать в цифровом виде или распечатать?

Answer 1

Maven-pdf-plugin генерирует PDF проектной документации.

Два замечания из документации для рассмотрения:

Примечание 1: по умолчанию плагин PDF генерирует документ PDF, который объединяет все документы вашего сайта. Если вы хотите сгенерировать каждый документ сайта отдельно, вам нужно добавить -Daggregate=false в командной строке.

Примечание 2: по умолчанию плагин PDF использует реализацию FOP. Плагин также поддерживает реализацию iText, вам просто нужно добавить -Dimplementation=itext в командной строке.

Вы действительно можете указать агрегатное свойство в своем POM (см. Пример ниже).

Эта конфигурация будет генерировать PDF на каждой сборке, docs профиль активен (вы можете сделать это при каждой сборке, но он будет немного медленным для вашего типичного цикла разработки:

<profiles>
  <profile>
    <id>docs</id>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pdf-plugin</artifactId>
      <version>1.0</version>
      <executions>
        <execution>
          <id>pdf</id>
          <phase>site</phase>
          <goals>
            <goal>pdf</goal>
          </goals>
          <configuration>
            <outputDirectory>
              ${project.reporting.outputDirectory}
            </outputDirectory>
            <aggregate>false</aggregate>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </profile>
</profiles>

Вы можете активировать профиль в командной строке с помощью -P docs или используйте конфигурацию активации, если вы хотите быть более детальным.