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-codec-binfmt</artifactId>
  68         </dependency>
  69         <dependency>
  70             <groupId>org.opendaylight.yangtools</groupId>
  71             <artifactId>yang-data-codec-gson</artifactId>
  72         </dependency>
  73         <dependency>
  74             <groupId>org.opendaylight.yangtools</groupId>
  75             <artifactId>yang-data-codec-xml</artifactId>
  76         </dependency>
  77         <dependency>
  78             <groupId>org.opendaylight.yangtools</groupId>
  79             <artifactId>yang-model-api</artifactId>
  80         </dependency>
  81         <dependency>
  82             <groupId>org.opendaylight.yangtools</groupId>
  83             <artifactId>yang-model-spi</artifactId>
  84         </dependency>
  85         <dependency>
  86             <groupId>org.opendaylight.yangtools</groupId>
  87             <artifactId>yang-model-export</artifactId>
  88         </dependency>
  89         <dependency>
  90             <groupId>org.opendaylight.yangtools</groupId>
  91             <artifactId>yang-model-util</artifactId>
  92         </dependency>
  93         <dependency>
  94             <groupId>org.opendaylight.yangtools</groupId>
  95             <artifactId>yang-parser-api</artifactId>
  96         </dependency>
  97         <dependency>
  98             <groupId>org.opendaylight.yangtools</groupId>
  99             <artifactId>yang-parser-spi</artifactId>
 100         </dependency>
 101         <dependency>
 102             <groupId>org.opendaylight.yangtools</groupId>
 103             <artifactId>yang-parser-reactor</artifactId>
 104         </dependency>
 105         <dependency>
 106             <groupId>org.opendaylight.yangtools</groupId>
 107             <artifactId>yang-parser-impl</artifactId>
 108         </dependency>
 109         <dependency>
 110             <groupId>org.opendaylight.yangtools</groupId>
 111             <artifactId>yang-parser-antlr</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-antlr</artifactId>
 226         </dependency>
 227         <dependency>
 228             <groupId>org.opendaylight.yangtools</groupId>
 229             <artifactId>yang-xpath-impl</artifactId>
 230         </dependency>
 231
 232         <dependency>
 233             <groupId>org.opendaylight.yangtools</groupId>
 234             <artifactId>util</artifactId>
 235         </dependency>
 236
 237         <dependency>
 238             <groupId>org.opendaylight.yangtools</groupId>
 239             <artifactId>testutils</artifactId>
 240         </dependency>
 241
 242         <!-- Also add dependencies we are using -->
 243         <dependency>
 244             <groupId>org.kohsuke.metainf-services</groupId>
 245             <artifactId>metainf-services</artifactId>
 246             <scope>provided</scope>
 247         </dependency>
 248         <dependency>
 249             <groupId>org.osgi</groupId>
 250             <artifactId>osgi.cmpn</artifactId>
 251             <scope>provided</scope>
 252         </dependency>
 253         <dependency>
 254             <groupId>org.osgi</groupId>
 255             <artifactId>org.osgi.service.component.annotations</artifactId>
 256             <scope>provided</scope>
 257         </dependency>
 258         <dependency>
 259             <groupId>org.immutables</groupId>
 260             <artifactId>value</artifactId>
 261             <classifier>annotations</classifier>
 262             <scope>provided</scope>
 263         </dependency>
 264         <dependency>
 265             <groupId>org.apache.maven</groupId>
 266             <artifactId>maven-core</artifactId>
 267             <scope>provided</scope>
 268         </dependency>
 269         <dependency>
 270             <groupId>org.sonatype.plexus</groupId>
 271             <artifactId>plexus-build-api</artifactId>
 272             <scope>provided</scope>
 273         </dependency>
 274         <dependency>
 275             <groupId>org.mockito</groupId>
 276             <artifactId>mockito-core</artifactId>
 277             <scope>provided</scope>
 278         </dependency>
 279     </dependencies>
 280
 281     <build>
 282         <plugins>
 283             <plugin>
 284                 <groupId>org.asciidoctor</groupId>
 285                 <artifactId>asciidoctor-maven-plugin</artifactId>
 286                 <version>1.5.7.1</version>
 287                 <executions>
 288                     <execution>
 289                         <id>output-html</id>
 290                         <phase>generate-resources</phase>
 291                         <goals>
 292                             <goal>process-asciidoc</goal>
 293                         </goals>
 294                         <configuration>
 295                             <sourceHighlighter>coderay</sourceHighlighter>
 296                             <backend>html</backend>
 297                             <attributes>
 298                                 <toc/>
 299                                 <linkcss>false</linkcss>
 300                             </attributes>
 301                         </configuration>
 302                     </execution>
 303                 </executions>
 304                 <configuration>
 305                     <attributes>
 306                         <revnumber>${project.version}</revnumber>
 307                         <revdate>${maven.build.timestamp}</revdate>
 308                         <organization>${project.organization.name}</organization>
 309                     </attributes>
 310                 </configuration>
 311             </plugin>
 312
 313             <plugin>
 314                 <artifactId>maven-dependency-plugin</artifactId>
 315                 <executions>
 316                     <execution>
 317                         <id>unpack-sources</id>
 318                         <phase>process-classes</phase>
 319                         <goals>
 320                             <goal>unpack-dependencies</goal>
 321                         </goals>
 322                         <configuration>
 323                             <silent>true</silent>
 324                             <classifier>sources</classifier>
 325                             <includes>org/opendaylight/**</includes>
 326                             <includeGroupIds>org.opendaylight.yangtools</includeGroupIds>
 327                             <outputDirectory>${project.build.directory}/src</outputDirectory>
 328                         </configuration>
 329                     </execution>
 330                 </executions>
 331             </plugin>
 332             <plugin>
 333                 <groupId>org.codehaus.mojo</groupId>
 334                 <artifactId>build-helper-maven-plugin</artifactId>
 335                 <executions>
 336                     <execution>
 337                         <id>add-source</id>
 338                         <phase>process-classes</phase>
 339                         <goals>
 340                             <goal>add-source</goal>
 341                         </goals>
 342                         <configuration>
 343                             <sources>
 344                                 <source>${project.build.directory}/src</source>
 345                             </sources>
 346                         </configuration>
 347                     </execution>
 348                 </executions>
 349             </plugin>
 350
 351             <plugin>
 352                 <artifactId>maven-source-plugin</artifactId>
 353                 <executions>
 354                     <execution>
 355                         <id>attach-sources</id>
 356                         <!-- prepare-package so we build the source package before javadoc -->
 357                         <phase>prepare-package</phase>
 358                         <goals>
 359                             <goal>jar-no-fork</goal>
 360                         </goals>
 361                     </execution>
 362                 </executions>
 363             </plugin>
 364
 365             <plugin>
 366                 <artifactId>maven-javadoc-plugin</artifactId>
 367                 <executions>
 368                     <execution>
 369                         <id>attach-javadocs</id>
 370                         <goals>
 371                             <goal>jar</goal>
 372                         </goals>
 373                     </execution>
 374                 </executions>
 375                 <!-- FIXME: remove this section once we can activate javadoc-links profile -->
 376                 <configuration combine.children="append">
 377                     <links>
 378                         <link>https://junit.org/junit4/javadoc/4.13/</link>
 379                         <link>http://hamcrest.org/JavaHamcrest/javadoc/2.2/</link>
 380                         <link>http://google.github.io/truth/api/1.0.1/</link>
 381                         <link>http://www.slf4j.org/apidocs/</link>
 382                         <link>https://google.github.io/guava/releases/28.2-jre/api/docs/</link>
 383                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/</link>
 384                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-3.10/</link>
 385                         <link>https://commons.apache.org/proper/commons-codec/apidocs/</link>
 386
 387                         <link>https://www.javadoc.io/doc/org.opendaylight.odlparent/odlparent-docs/9.0.8/</link>
 388                     </links>
 389                     <groups>
 390                         <group>
 391                             <title>Common concepts</title>
 392                             <packages>org.opendaylight.yangtools.concepts*</packages>
 393                         </group>
 394                         <group>
 395                             <title>Common utilities</title>
 396                             <packages>org.opendaylight.yangtools.util*</packages>
 397                         </group>
 398                         <group>
 399                             <title>Common YANG constructs</title>
 400                             <packages>org.opendaylight.yangtools.yang.common*</packages>
 401                         </group>
 402                         <group>
 403                             <title>YANG schema interfaces</title>
 404                             <packages>org.opendaylight.yangtools.yang.model.api*:org.opendaylight.yangtools.yang.model.util*</packages>
 405                         </group>
 406                         <group>
 407                             <title>YANG data tree interfaces</title>
 408                             <packages>org.opendaylight.yangtools.yang.data.api*:org.opendaylight.yangtools.yang.data.util*</packages>
 409                         </group>
 410                         <group>
 411                             <title>yang-maven-plugin codegen interface</title>
 412                             <packages>org.opendaylight.yangtools.plugin.generator.api*:org.opendaylight.yangtools.yang2sources.spi*</packages>
 413                         </group>
 414                         <group>
 415                             <title>Common YANG parser</title>
 416                             <packages>org.opendaylight.yangtools.yang.parser*</packages>
 417                         </group>
 418                         <group>
 419                             <title>DataInput/DataOutput streaming interfaces</title>
 420                             <packages>org.opendaylight.yangtools.yang.data.codec.binfmt*</packages>
 421                         </group>
 422                     </groups>
 423                 </configuration>
 424             </plugin>
 425         </plugins>
 426     </build>
 427 </project>