93675617af519595e49e11c74e5725bb977e2541
[yangtools.git] / docs / pom.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- vi: set et smarttab sw=4 tabstop=4: -->
3 <!--
4  Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
5
6  This program and the accompanying materials are made available under the
7  terms of the Eclipse Public License v1.0 which accompanies this distribution,
8  and is available at http://www.eclipse.org/legal/epl-v10.html
9 -->
10 <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">
11     <modelVersion>4.0.0</modelVersion>
12     <parent>
13         <groupId>org.opendaylight.yangtools</groupId>
14         <artifactId>bundle-parent</artifactId>
15         <version>6.0.6-SNAPSHOT</version>
16         <relativePath>../bundle-parent</relativePath>
17     </parent>
18
19     <artifactId>yangtools-docs</artifactId>
20     <packaging>jar</packaging>
21     <name>${project.artifactId}</name>
22     <description>YANG Tools documentation</description>
23
24     <dependencies>
25         <dependency>
26             <groupId>org.opendaylight.yangtools</groupId>
27             <artifactId>yang-data-util</artifactId>
28         </dependency>
29         <dependency>
30             <groupId>org.opendaylight.yangtools</groupId>
31             <artifactId>concepts</artifactId>
32         </dependency>
33         <dependency>
34             <groupId>org.opendaylight.yangtools</groupId>
35             <artifactId>plugin-generator-api</artifactId>
36         </dependency>
37         <dependency>
38             <groupId>org.opendaylight.yangtools</groupId>
39             <artifactId>yang-common</artifactId>
40         </dependency>
41         <dependency>
42             <groupId>org.opendaylight.yangtools</groupId>
43             <artifactId>yang-common-netty</artifactId>
44         </dependency>
45         <dependency>
46             <groupId>org.opendaylight.yangtools</groupId>
47             <artifactId>yang-data-api</artifactId>
48         </dependency>
49         <dependency>
50             <groupId>org.opendaylight.yangtools</groupId>
51             <artifactId>yang-data-impl</artifactId>
52         </dependency>
53         <dependency>
54             <groupId>org.opendaylight.yangtools</groupId>
55             <artifactId>yang-data-transform</artifactId>
56         </dependency>
57         <dependency>
58             <groupId>org.opendaylight.yangtools</groupId>
59             <artifactId>yang-data-jaxen</artifactId>
60         </dependency>
61         <dependency>
62             <groupId>org.opendaylight.yangtools</groupId>
63             <artifactId>yang-data-codec-binfmt</artifactId>
64         </dependency>
65         <dependency>
66             <groupId>org.opendaylight.yangtools</groupId>
67             <artifactId>yang-data-codec-gson</artifactId>
68         </dependency>
69         <dependency>
70             <groupId>org.opendaylight.yangtools</groupId>
71             <artifactId>yang-data-codec-xml</artifactId>
72         </dependency>
73         <dependency>
74             <groupId>org.opendaylight.yangtools</groupId>
75             <artifactId>yang-model-api</artifactId>
76         </dependency>
77         <dependency>
78             <groupId>org.opendaylight.yangtools</groupId>
79             <artifactId>yang-model-export</artifactId>
80         </dependency>
81         <dependency>
82             <groupId>org.opendaylight.yangtools</groupId>
83             <artifactId>yang-model-util</artifactId>
84         </dependency>
85         <dependency>
86             <groupId>org.opendaylight.yangtools</groupId>
87             <artifactId>yang-parser-api</artifactId>
88         </dependency>
89         <dependency>
90             <groupId>org.opendaylight.yangtools</groupId>
91             <artifactId>yang-parser-spi</artifactId>
92         </dependency>
93         <dependency>
94             <groupId>org.opendaylight.yangtools</groupId>
95             <artifactId>yang-parser-reactor</artifactId>
96         </dependency>
97         <dependency>
98             <groupId>org.opendaylight.yangtools</groupId>
99             <artifactId>yang-parser-impl</artifactId>
100         </dependency>
101         <dependency>
102             <groupId>org.opendaylight.yangtools</groupId>
103             <artifactId>yang-parser-antlr</artifactId>
104         </dependency>
105         <dependency>
106             <groupId>org.opendaylight.yangtools</groupId>
107             <artifactId>yang-parser-rfc7950</artifactId>
108         </dependency>
109         <dependency>
110             <groupId>org.opendaylight.yangtools</groupId>
111             <artifactId>yang-test-util</artifactId>
112             <scope>provided</scope>
113         </dependency>
114         <dependency>
115             <groupId>org.opendaylight.yangtools</groupId>
116             <artifactId>yang-maven-plugin-spi</artifactId>
117         </dependency>
118
119         <dependency>
120             <groupId>org.opendaylight.yangtools</groupId>
121             <artifactId>odlext-model-api</artifactId>
122         </dependency>
123         <dependency>
124             <groupId>org.opendaylight.yangtools</groupId>
125             <artifactId>odlext-parser-support</artifactId>
126         </dependency>
127
128         <dependency>
129             <groupId>org.opendaylight.yangtools</groupId>
130             <artifactId>openconfig-model-api</artifactId>
131         </dependency>
132         <dependency>
133             <groupId>org.opendaylight.yangtools</groupId>
134             <artifactId>openconfig-parser-support</artifactId>
135         </dependency>
136
137         <dependency>
138             <groupId>org.opendaylight.yangtools</groupId>
139             <artifactId>rfc6536-model-api</artifactId>
140         </dependency>
141         <dependency>
142             <groupId>org.opendaylight.yangtools</groupId>
143             <artifactId>rfc6536-parser-support</artifactId>
144         </dependency>
145
146         <dependency>
147             <groupId>org.opendaylight.yangtools</groupId>
148             <artifactId>rfc6643-model-api</artifactId>
149         </dependency>
150         <dependency>
151             <groupId>org.opendaylight.yangtools</groupId>
152             <artifactId>rfc6643-parser-support</artifactId>
153         </dependency>
154
155         <dependency>
156             <groupId>org.opendaylight.yangtools</groupId>
157             <artifactId>rfc7952-model-api</artifactId>
158         </dependency>
159         <dependency>
160             <groupId>org.opendaylight.yangtools</groupId>
161             <artifactId>rfc7952-parser-support</artifactId>
162         </dependency>
163
164         <dependency>
165             <groupId>org.opendaylight.yangtools</groupId>
166             <artifactId>rfc8040-model-api</artifactId>
167         </dependency>
168         <dependency>
169             <groupId>org.opendaylight.yangtools</groupId>
170             <artifactId>rfc8040-parser-support</artifactId>
171         </dependency>
172
173         <dependency>
174             <groupId>org.opendaylight.yangtools</groupId>
175             <artifactId>rfc8528-model-api</artifactId>
176         </dependency>
177         <dependency>
178             <groupId>org.opendaylight.yangtools</groupId>
179             <artifactId>rfc8528-data-api</artifactId>
180         </dependency>
181         <dependency>
182             <groupId>org.opendaylight.yangtools</groupId>
183             <artifactId>rfc8528-data-util</artifactId>
184         </dependency>
185         <dependency>
186             <groupId>org.opendaylight.yangtools</groupId>
187             <artifactId>rfc8528-parser-support</artifactId>
188         </dependency>
189
190         <dependency>
191             <groupId>org.opendaylight.yangtools</groupId>
192             <artifactId>yang-xpath-api</artifactId>
193         </dependency>
194         <dependency>
195             <groupId>org.opendaylight.yangtools</groupId>
196             <artifactId>yang-xpath-antlr</artifactId>
197         </dependency>
198         <dependency>
199             <groupId>org.opendaylight.yangtools</groupId>
200             <artifactId>yang-xpath-impl</artifactId>
201         </dependency>
202
203         <dependency>
204             <groupId>org.opendaylight.yangtools</groupId>
205             <artifactId>util</artifactId>
206         </dependency>
207
208         <dependency>
209             <groupId>org.opendaylight.yangtools</groupId>
210             <artifactId>testutils</artifactId>
211         </dependency>
212
213         <!-- Also add dependencies we are using -->
214         <dependency>
215             <groupId>org.kohsuke.metainf-services</groupId>
216             <artifactId>metainf-services</artifactId>
217             <scope>provided</scope>
218         </dependency>
219         <dependency>
220             <groupId>org.osgi</groupId>
221             <artifactId>osgi.cmpn</artifactId>
222             <scope>provided</scope>
223         </dependency>
224         <dependency>
225             <groupId>org.osgi</groupId>
226             <artifactId>org.osgi.service.component.annotations</artifactId>
227             <scope>provided</scope>
228         </dependency>
229         <dependency>
230             <groupId>org.immutables</groupId>
231             <artifactId>value</artifactId>
232             <classifier>annotations</classifier>
233             <scope>provided</scope>
234         </dependency>
235         <dependency>
236             <groupId>org.apache.maven</groupId>
237             <artifactId>maven-core</artifactId>
238             <scope>provided</scope>
239         </dependency>
240         <dependency>
241             <groupId>org.sonatype.plexus</groupId>
242             <artifactId>plexus-build-api</artifactId>
243             <scope>provided</scope>
244         </dependency>
245         <dependency>
246             <groupId>org.mockito</groupId>
247             <artifactId>mockito-core</artifactId>
248             <scope>provided</scope>
249         </dependency>
250     </dependencies>
251
252     <build>
253         <plugins>
254             <plugin>
255                 <groupId>org.asciidoctor</groupId>
256                 <artifactId>asciidoctor-maven-plugin</artifactId>
257                 <version>1.5.7.1</version>
258                 <executions>
259                     <execution>
260                         <id>output-html</id>
261                         <phase>generate-resources</phase>
262                         <goals>
263                             <goal>process-asciidoc</goal>
264                         </goals>
265                         <configuration>
266                             <sourceHighlighter>coderay</sourceHighlighter>
267                             <backend>html</backend>
268                             <attributes>
269                                 <toc/>
270                                 <linkcss>false</linkcss>
271                             </attributes>
272                         </configuration>
273                     </execution>
274                 </executions>
275                 <configuration>
276                     <attributes>
277                         <revnumber>${project.version}</revnumber>
278                         <revdate>${maven.build.timestamp}</revdate>
279                         <organization>${project.organization.name}</organization>
280                     </attributes>
281                 </configuration>
282             </plugin>
283
284             <plugin>
285                 <artifactId>maven-dependency-plugin</artifactId>
286                 <executions>
287                     <execution>
288                         <id>unpack-sources</id>
289                         <phase>process-classes</phase>
290                         <goals>
291                             <goal>unpack-dependencies</goal>
292                         </goals>
293                         <configuration>
294                             <silent>true</silent>
295                             <classifier>sources</classifier>
296                             <includes>org/opendaylight/**</includes>
297                             <includeGroupIds>org.opendaylight.yangtools</includeGroupIds>
298                             <outputDirectory>${project.build.directory}/src</outputDirectory>
299                         </configuration>
300                     </execution>
301                 </executions>
302             </plugin>
303             <plugin>
304                 <groupId>org.codehaus.mojo</groupId>
305                 <artifactId>build-helper-maven-plugin</artifactId>
306                 <executions>
307                     <execution>
308                         <id>add-source</id>
309                         <phase>process-classes</phase>
310                         <goals>
311                             <goal>add-source</goal>
312                         </goals>
313                         <configuration>
314                             <sources>
315                                 <source>${project.build.directory}/src</source>
316                             </sources>
317                         </configuration>
318                     </execution>
319                 </executions>
320             </plugin>
321
322             <plugin>
323                 <artifactId>maven-source-plugin</artifactId>
324                 <executions>
325                     <execution>
326                         <id>attach-sources</id>
327                         <!-- prepare-package so we build the source package before javadoc -->
328                         <phase>prepare-package</phase>
329                         <goals>
330                             <goal>jar-no-fork</goal>
331                         </goals>
332                     </execution>
333                 </executions>
334             </plugin>
335
336             <plugin>
337                 <artifactId>maven-javadoc-plugin</artifactId>
338                 <executions>
339                     <execution>
340                         <id>attach-javadocs</id>
341                         <goals>
342                             <goal>jar</goal>
343                         </goals>
344                     </execution>
345                 </executions>
346                 <!-- FIXME: remove this section once we can activate javadoc-links profile -->
347                 <configuration combine.children="append">
348                     <links>
349                         <link>https://junit.org/junit4/javadoc/4.13/</link>
350                         <link>http://hamcrest.org/JavaHamcrest/javadoc/2.2/</link>
351                         <link>http://google.github.io/truth/api/1.0.1/</link>
352                         <link>http://www.slf4j.org/apidocs/</link>
353                         <link>https://google.github.io/guava/releases/28.2-jre/api/docs/</link>
354                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/</link>
355                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-3.10/</link>
356                         <link>https://commons.apache.org/proper/commons-codec/apidocs/</link>
357
358                         <link>https://www.javadoc.io/doc/org.opendaylight.odlparent/odlparent-docs/8.1.1/</link>
359                     </links>
360                     <groups>
361                         <group>
362                             <title>Common concepts</title>
363                             <packages>org.opendaylight.yangtools.concepts*</packages>
364                         </group>
365                         <group>
366                             <title>Common utilities</title>
367                             <packages>org.opendaylight.yangtools.util*</packages>
368                         </group>
369                         <group>
370                             <title>Common YANG constructs</title>
371                             <packages>org.opendaylight.yangtools.yang.common*</packages>
372                         </group>
373                         <group>
374                             <title>YANG schema interfaces</title>
375                             <packages>org.opendaylight.yangtools.yang.model.api*:org.opendaylight.yangtools.yang.model.util*</packages>
376                         </group>
377                         <group>
378                             <title>YANG data tree interfaces</title>
379                             <packages>org.opendaylight.yangtools.yang.data.api*:org.opendaylight.yangtools.yang.data.util*</packages>
380                         </group>
381                         <group>
382                             <title>yang-maven-plugin codegen interface</title>
383                             <packages>org.opendaylight.yangtools.plugin.generator.api*:org.opendaylight.yangtools.yang2sources.spi*</packages>
384                         </group>
385                         <group>
386                             <title>Common YANG parser</title>
387                             <packages>org.opendaylight.yangtools.yang.parser*</packages>
388                         </group>
389                         <group>
390                             <title>DataInput/DataOutput streaming interfaces</title>
391                             <packages>org.opendaylight.yangtools.yang.data.codec.binfmt*</packages>
392                         </group>
393                     </groups>
394                 </configuration>
395             </plugin>
396         </plugins>
397     </build>
398 </project>