summaryrefslogtreecommitdiffstats
path: root/vpp-integration/api-docs/docs/pom.xml
blob: 6545ed6719aef788c098d149a69bc4875ee9c28c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (c) 2017 Cisco and/or its affiliates.
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at:
  ~
  ~     http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>io.fd.hc2vpp.docs</groupId>
    <artifactId>docs</artifactId>
    <version>1.18.07-SNAPSHOT</version>
    <name>${project.artifactId}</name>

    <properties>
        <!-- List of modules that are used to extract Writer/Reader factories, and therefore generate api documentation -->
        <api.docs.modules>
            io.fd.hc2vpp.docs.core.mock.binding.MockBindingModule,
            io.fd.hc2vpp.management.VppManagementModule,
            io.fd.hc2vpp.lisp.LispModule,
            io.fd.hc2vpp.lisp.gpe.GpeModule,
            io.fd.hc2vpp.v3po.V3poModule,
            io.fd.hc2vpp.iface.role.InterfaceRoleModule,
            io.fd.hc2vpp.l3.InterfaceL3Module,
            io.fd.hc2vpp.l3.SubInterfaceL3Module,
            io.fd.hc2vpp.l3.ProxyArpModule,
            io.fd.hc2vpp.vpp.classifier.VppClassifierModule,
            io.fd.hc2vpp.vpp.classifier.InterfaceClassifierAclModule,
            io.fd.hc2vpp.vpp.classifier.SubInterfaceClassifierAclModule,
            io.fd.hc2vpp.docs.core.mock.binding.MockNatModule,
            io.fd.hc2vpp.routing.RoutingModule,
            io.fd.hc2vpp.docs.core.mock.binding.MockAclModule,
            io.fd.hc2vpp.dhcp.DhcpModule,
            io.fd.hc2vpp.policer.PolicerModule,
            io.fd.hc2vpp.mpls.MplsModule,
            io.fd.hc2vpp.docs.core.mock.binding.MockNshModule,
            io.fd.hc2vpp.docs.core.mock.binding.MockIoamModule,
            io.fd.hc2vpp.bgp.inet.BgpInetModule,
            io.fd.hc2vpp.bgp.prefix.sid.BgpPrefixSidModule
        </api.docs.modules>
        <project.root.folder>${project.basedir}/../../..</project.root.folder>
    </properties>

    <build>
        <pluginManagement>
            <plugins>
                <!--
                    Module is used just for build (docs are rendered in release-notes), so skip site.
                    In case we change our minds, we need to provide distributionManagement.
                -->
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-site-plugin</artifactId>
                    <configuration>
                        <skip>true</skip>
                        <skipDeploy>true</skipDeploy>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.6.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.codehaus.gmaven</groupId>
                <artifactId>groovy-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>generate-coverage-doc</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>execute</goal>
                        </goals>
                        <configuration>
                            <source>
                                io.fd.hc2vpp.docs.scripts.ApiDocsIndexGenerator.generate(project, log)
                            </source>
                        </configuration>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>io.fd.hc2vpp.docs</groupId>
                        <artifactId>scripts</artifactId>
                        <version>${project.version}</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>