f3630ebeccf5b87cea4bde0f52fadae0cd237151
[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>8.0.0-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-tree-api</artifactId>
60         </dependency>
61         <dependency>
62             <groupId>org.opendaylight.yangtools</groupId>
63             <artifactId>yang-data-tree-spi</artifactId>
64         </dependency>
65         <dependency>
66             <groupId>org.opendaylight.yangtools</groupId>
67             <artifactId>yang-data-tree-ri</artifactId>
68         </dependency>
69         <dependency>
70             <groupId>org.opendaylight.yangtools</groupId>
71             <artifactId>yang-data-codec-binfmt</artifactId>
72         </dependency>
73         <dependency>
74             <groupId>org.opendaylight.yangtools</groupId>
75             <artifactId>yang-data-codec-gson</artifactId>
76         </dependency>
77         <dependency>
78             <groupId>org.opendaylight.yangtools</groupId>
79             <artifactId>yang-data-codec-xml</artifactId>
80         </dependency>
81         <dependency>
82             <groupId>org.opendaylight.yangtools</groupId>
83             <artifactId>yang-model-api</artifactId>
84         </dependency>
85         <dependency>
86             <groupId>org.opendaylight.yangtools</groupId>
87             <artifactId>yang-model-spi</artifactId>
88         </dependency>
89         <dependency>
90             <groupId>org.opendaylight.yangtools</groupId>
91             <artifactId>yang-model-export</artifactId>
92         </dependency>
93         <dependency>
94             <groupId>org.opendaylight.yangtools</groupId>
95             <artifactId>yang-model-util</artifactId>
96         </dependency>
97         <dependency>
98             <groupId>org.opendaylight.yangtools</groupId>
99             <artifactId>yang-parser-api</artifactId>
100         </dependency>
101         <dependency>
102             <groupId>org.opendaylight.yangtools</groupId>
103             <artifactId>yang-parser-spi</artifactId>
104         </dependency>
105         <dependency>
106             <groupId>org.opendaylight.yangtools</groupId>
107             <artifactId>yang-parser-reactor</artifactId>
108         </dependency>
109         <dependency>
110             <groupId>org.opendaylight.yangtools</groupId>
111             <artifactId>yang-parser-impl</artifactId>
112         </dependency>
113         <dependency>
114             <groupId>org.opendaylight.yangtools</groupId>
115             <artifactId>yang-parser-antlr</artifactId>
116         </dependency>
117         <dependency>
118             <groupId>org.opendaylight.yangtools</groupId>
119             <artifactId>yang-parser-rfc7950</artifactId>
120         </dependency>
121         <dependency>
122             <groupId>org.opendaylight.yangtools</groupId>
123             <artifactId>yang-repo-api</artifactId>
124         </dependency>
125         <dependency>
126             <groupId>org.opendaylight.yangtools</groupId>
127             <artifactId>yang-repo-spi</artifactId>
128         </dependency>
129         <dependency>
130             <groupId>org.opendaylight.yangtools</groupId>
131             <artifactId>yang-repo-fs</artifactId>
132         </dependency>
133         <dependency>
134             <groupId>org.opendaylight.yangtools</groupId>
135             <artifactId>yang-test-util</artifactId>
136             <scope>provided</scope>
137         </dependency>
138         <dependency>
139             <groupId>org.opendaylight.yangtools</groupId>
140             <artifactId>yang-maven-plugin-spi</artifactId>
141         </dependency>
142
143         <dependency>
144             <groupId>org.opendaylight.yangtools</groupId>
145             <artifactId>odlext-model-api</artifactId>
146         </dependency>
147         <dependency>
148             <groupId>org.opendaylight.yangtools</groupId>
149             <artifactId>odlext-parser-support</artifactId>
150         </dependency>
151
152         <dependency>
153             <groupId>org.opendaylight.yangtools</groupId>
154             <artifactId>openconfig-model-api</artifactId>
155         </dependency>
156         <dependency>
157             <groupId>org.opendaylight.yangtools</groupId>
158             <artifactId>openconfig-parser-support</artifactId>
159         </dependency>
160
161         <dependency>
162             <groupId>org.opendaylight.yangtools</groupId>
163             <artifactId>rfc6536-model-api</artifactId>
164         </dependency>
165         <dependency>
166             <groupId>org.opendaylight.yangtools</groupId>
167             <artifactId>rfc6536-parser-support</artifactId>
168         </dependency>
169
170         <dependency>
171             <groupId>org.opendaylight.yangtools</groupId>
172             <artifactId>rfc6643-model-api</artifactId>
173         </dependency>
174         <dependency>
175             <groupId>org.opendaylight.yangtools</groupId>
176             <artifactId>rfc6643-parser-support</artifactId>
177         </dependency>
178
179         <dependency>
180             <groupId>org.opendaylight.yangtools</groupId>
181             <artifactId>rfc7952-model-api</artifactId>
182         </dependency>
183         <dependency>
184             <groupId>org.opendaylight.yangtools</groupId>
185             <artifactId>rfc7952-parser-support</artifactId>
186         </dependency>
187
188         <dependency>
189             <groupId>org.opendaylight.yangtools</groupId>
190             <artifactId>rfc8040-model-api</artifactId>
191         </dependency>
192         <dependency>
193             <groupId>org.opendaylight.yangtools</groupId>
194             <artifactId>rfc8040-parser-support</artifactId>
195         </dependency>
196
197         <dependency>
198             <groupId>org.opendaylight.yangtools</groupId>
199             <artifactId>rfc8528-data-api</artifactId>
200         </dependency>
201         <dependency>
202             <groupId>org.opendaylight.yangtools</groupId>
203             <artifactId>rfc8528-data-util</artifactId>
204         </dependency>
205         <dependency>
206             <groupId>org.opendaylight.yangtools</groupId>
207             <artifactId>rfc8528-model-api</artifactId>
208         </dependency>
209         <dependency>
210             <groupId>org.opendaylight.yangtools</groupId>
211             <artifactId>rfc8528-parser-support</artifactId>
212         </dependency>
213
214         <dependency>
215             <groupId>org.opendaylight.yangtools</groupId>
216             <artifactId>rfc8639-model-api</artifactId>
217         </dependency>
218         <dependency>
219             <groupId>org.opendaylight.yangtools</groupId>
220             <artifactId>rfc8639-parser-support</artifactId>
221         </dependency>
222
223         <dependency>
224             <groupId>org.opendaylight.yangtools</groupId>
225             <artifactId>yang-xpath-api</artifactId>
226         </dependency>
227         <dependency>
228             <groupId>org.opendaylight.yangtools</groupId>
229             <artifactId>yang-xpath-antlr</artifactId>
230         </dependency>
231         <dependency>
232             <groupId>org.opendaylight.yangtools</groupId>
233             <artifactId>yang-xpath-impl</artifactId>
234         </dependency>
235
236         <dependency>
237             <groupId>org.opendaylight.yangtools</groupId>
238             <artifactId>util</artifactId>
239         </dependency>
240
241         <dependency>
242             <groupId>org.opendaylight.yangtools</groupId>
243             <artifactId>testutils</artifactId>
244         </dependency>
245
246         <!-- Also add dependencies we are using -->
247         <dependency>
248             <groupId>org.kohsuke.metainf-services</groupId>
249             <artifactId>metainf-services</artifactId>
250             <scope>provided</scope>
251         </dependency>
252         <dependency>
253             <groupId>org.osgi</groupId>
254             <artifactId>osgi.cmpn</artifactId>
255             <scope>provided</scope>
256         </dependency>
257         <dependency>
258             <groupId>org.osgi</groupId>
259             <artifactId>org.osgi.service.component.annotations</artifactId>
260             <scope>provided</scope>
261         </dependency>
262         <dependency>
263             <groupId>org.immutables</groupId>
264             <artifactId>value</artifactId>
265             <classifier>annotations</classifier>
266             <scope>provided</scope>
267         </dependency>
268         <dependency>
269             <groupId>org.apache.maven</groupId>
270             <artifactId>maven-core</artifactId>
271             <scope>provided</scope>
272         </dependency>
273         <dependency>
274             <groupId>org.sonatype.plexus</groupId>
275             <artifactId>plexus-build-api</artifactId>
276             <scope>provided</scope>
277         </dependency>
278         <dependency>
279             <groupId>org.mockito</groupId>
280             <artifactId>mockito-core</artifactId>
281             <scope>provided</scope>
282         </dependency>
283     </dependencies>
284
285     <build>
286         <plugins>
287             <plugin>
288                 <groupId>org.asciidoctor</groupId>
289                 <artifactId>asciidoctor-maven-plugin</artifactId>
290                 <version>1.5.7.1</version>
291                 <executions>
292                     <execution>
293                         <id>output-html</id>
294                         <phase>generate-resources</phase>
295                         <goals>
296                             <goal>process-asciidoc</goal>
297                         </goals>
298                         <configuration>
299                             <sourceHighlighter>coderay</sourceHighlighter>
300                             <backend>html</backend>
301                             <attributes>
302                                 <toc/>
303                                 <linkcss>false</linkcss>
304                             </attributes>
305                         </configuration>
306                     </execution>
307                 </executions>
308                 <configuration>
309                     <attributes>
310                         <revnumber>${project.version}</revnumber>
311                         <revdate>${maven.build.timestamp}</revdate>
312                         <organization>${project.organization.name}</organization>
313                     </attributes>
314                 </configuration>
315             </plugin>
316
317             <plugin>
318                 <artifactId>maven-dependency-plugin</artifactId>
319                 <executions>
320                     <execution>
321                         <id>unpack-sources</id>
322                         <phase>process-classes</phase>
323                         <goals>
324                             <goal>unpack-dependencies</goal>
325                         </goals>
326                         <configuration>
327                             <silent>true</silent>
328                             <classifier>sources</classifier>
329                             <includes>org/opendaylight/**</includes>
330                             <includeGroupIds>org.opendaylight.yangtools</includeGroupIds>
331                             <outputDirectory>${project.build.directory}/src</outputDirectory>
332                         </configuration>
333                     </execution>
334                 </executions>
335             </plugin>
336             <plugin>
337                 <groupId>org.codehaus.mojo</groupId>
338                 <artifactId>build-helper-maven-plugin</artifactId>
339                 <executions>
340                     <execution>
341                         <id>add-source</id>
342                         <phase>process-classes</phase>
343                         <goals>
344                             <goal>add-source</goal>
345                         </goals>
346                         <configuration>
347                             <sources>
348                                 <source>${project.build.directory}/src</source>
349                             </sources>
350                         </configuration>
351                     </execution>
352                 </executions>
353             </plugin>
354
355             <plugin>
356                 <artifactId>maven-source-plugin</artifactId>
357                 <executions>
358                     <execution>
359                         <id>attach-sources</id>
360                         <!-- prepare-package so we build the source package before javadoc -->
361                         <phase>prepare-package</phase>
362                         <goals>
363                             <goal>jar-no-fork</goal>
364                         </goals>
365                     </execution>
366                 </executions>
367             </plugin>
368
369             <plugin>
370                 <artifactId>maven-javadoc-plugin</artifactId>
371                 <executions>
372                     <execution>
373                         <id>attach-javadocs</id>
374                         <goals>
375                             <goal>jar</goal>
376                         </goals>
377                     </execution>
378                 </executions>
379                 <!-- FIXME: remove this section once we can activate javadoc-links profile -->
380                 <configuration combine.children="append">
381                     <links>
382                         <link>https://junit.org/junit4/javadoc/4.13/</link>
383                         <link>http://hamcrest.org/JavaHamcrest/javadoc/2.2/</link>
384                         <link>http://google.github.io/truth/api/1.0.1/</link>
385                         <link>http://www.slf4j.org/apidocs/</link>
386                         <link>https://google.github.io/guava/releases/28.2-jre/api/docs/</link>
387                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/</link>
388                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-3.10/</link>
389                         <link>https://commons.apache.org/proper/commons-codec/apidocs/</link>
390
391                         <link>https://www.javadoc.io/doc/org.opendaylight.odlparent/odlparent-docs/9.0.10/</link>
392                     </links>
393                     <groups>
394                         <group>
395                             <title>Common concepts</title>
396                             <packages>org.opendaylight.yangtools.concepts*</packages>
397                         </group>
398                         <group>
399                             <title>Common utilities</title>
400                             <packages>org.opendaylight.yangtools.util*</packages>
401                         </group>
402                         <group>
403                             <title>Common YANG constructs</title>
404                             <packages>org.opendaylight.yangtools.yang.common*</packages>
405                         </group>
406                         <group>
407                             <title>YANG schema interfaces</title>
408                             <packages>org.opendaylight.yangtools.yang.model.api*:org.opendaylight.yangtools.yang.model.util*</packages>
409                         </group>
410                         <group>
411                             <title>YANG data tree interfaces</title>
412                             <packages>org.opendaylight.yangtools.yang.data.api*:org.opendaylight.yangtools.yang.data.util*</packages>
413                         </group>
414                         <group>
415                             <title>yang-maven-plugin codegen interface</title>
416                             <packages>org.opendaylight.yangtools.plugin.generator.api*:org.opendaylight.yangtools.yang2sources.spi*</packages>
417                         </group>
418                         <group>
419                             <title>Common YANG parser</title>
420                             <packages>org.opendaylight.yangtools.yang.parser*</packages>
421                         </group>
422                         <group>
423                             <title>DataInput/DataOutput streaming interfaces</title>
424                             <packages>org.opendaylight.yangtools.yang.data.codec.binfmt*</packages>
425                         </group>
426                     </groups>
427                 </configuration>
428             </plugin>
429         </plugins>
430     </build>
431 </project>