diff options
author | Jan Srnicek <jsrnicek@cisco.com> | 2017-07-21 15:10:46 +0200 |
---|---|---|
committer | Marek Gradzki <mgradzki@cisco.com> | 2017-07-25 12:28:32 +0200 |
commit | aa44951faf04e2cddfc537bbc9f6a18d76c76ec1 (patch) | |
tree | 5d12ef3105e49495db20dcb052a76d23c953cc03 /release-notes/pom.xml | |
parent | 4f15c1ba2bec17a5e62e3bb2656454abb86ca6e5 (diff) |
HC2VPP-180 - Doc coverage generator
TODO - links to specific vpp api section(now points
just to section with apis)
TODO - links to specific java binding code(now
points to class thats doing binding)
TODO - operational coverage(ASM does not support lambda processing)
TODO - generate coverage adoc links
Change-Id: I44c85012da3bd2e7cdd41930753e5aae6955cd7b
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'release-notes/pom.xml')
-rw-r--r-- | release-notes/pom.xml | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/release-notes/pom.xml b/release-notes/pom.xml index 1fc670f31..c34c7b45c 100644 --- a/release-notes/pom.xml +++ b/release-notes/pom.xml @@ -31,6 +31,14 @@ <modelVersion>4.0.0</modelVersion> <description>Hc2vpp release notes</description> + <dependencies> + <dependency> + <groupId>io.fd.hc2vpp.docs</groupId> + <artifactId>docs</artifactId> + <version>${project.version}</version> + </dependency> + </dependencies> + <!-- Do not push, this is just a documentation producer --> <build> <plugins> @@ -50,6 +58,25 @@ </plugin> <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <version>2.10</version> + <executions> + <execution> + <id>unpack-configuration</id> + <phase>generate-sources</phase> + <goals> + <goal>unpack-dependencies</goal> + </goals> + <configuration> + <includes>*.adoc</includes> + <outputDirectory>${project.build.directory}/raw-adoc/api_docs</outputDirectory> + </configuration> + </execution> + </executions> + </plugin> + + <plugin> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>${asciidoctor.maven.plugin.version}</version> @@ -63,6 +90,9 @@ <configuration> <!-- https://github.com/asciidoctor/asciidoctor-maven-plugin --> <!-- http://asciidoctor.org/docs/asciidoc-syntax-quick-reference --> + <!-- raw-adoc folder combines docs from src folder + generated api docs files, + in order to have them all available while generating site --> + <baseDir>${project.build.directory}/raw-adoc</baseDir> <backend>html5</backend> <doctype>docbook</doctype> <sourceHighlighter>coderay</sourceHighlighter> @@ -101,6 +131,21 @@ <artifactId>maven-resources-plugin</artifactId> <executions> <execution> + <id>copy-raw-adoc</id> + <phase>generate-sources</phase> + <goals> + <goal>copy-resources</goal> + </goals> + <configuration> + <outputDirectory>${project.build.directory}/raw-adoc</outputDirectory> + <resources> + <resource> + <directory>${project.basedir}/src/main/asciidoc/</directory> + </resource> + </resources> + </configuration> + </execution> + <execution> <id>copy-release-notes-to-site</id> <phase>site</phase> <goals> |