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