使用maven(不是gradle)使用spring rest docs生成asciidoctor doc

时间:2017-08-13 07:55:15

标签: spring maven gradle spring-restdocs

使用gradle生成asciidoctor文档,您需要在命令行中gradle asciidoctor,文档由此任务生成。

使用maven,我可以使用mvn package生成asciidoctor文档。但这包装了所有项目。有没有办法使用mvn生成文档而不包装所有项目?

1 个答案:

答案 0 :(得分:1)

Introduction to the Build Lifecycle。通常在Maven中,文档生成/打包绑定到site生命周期,这意味着它将在运行mvn site时创建。

以下是Javadoc如何将插件绑定到site阶段的示例:

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <phase>site</phase>
      <goals>
        <goal>jar</goal>
      </goals>
      <configuration>
      ...
      </configuration>
    </plugin>
  </plugins>
</build>

您也可以直接使用asciidoctor-maven-plugin

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.4</version>
            <dependencies>
                <dependency>
                    <groupId>org.asciidoctor</groupId>
                    <artifactId>asciidoctor-maven-plugin</artifactId>
                    <version>{release-version}</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

(摘自asciidoctor documentation