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