Fix yangtools-docs

Current docs fail to correctly deploy, fix that up. Also group
packages to make them more readable.

Change-Id: Iebf8c785ca0fd7968724759a2b593ca559620057
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/artifacts/pom.xml b/artifacts/pom.xml
index c2826ebe31ef8191b44f596a2ecb3bb2d61e2be8..9cd9e1185182165ae3fe7f6cbd3b94108a06eb7d 100644 (file)
--- a/artifacts/pom.xml
+++ b/artifacts/pom.xml
@@ -343,20 +343,6 @@
                 <groupId>org.opendaylight.yangtools</groupId>
                 <artifactId>yangtools-docs</artifactId>
                 <version>2.0.9-SNAPSHOT</version>
-                <type>zip</type>
-                <classifier>guides</classifier>
-            </dependency>
-            <dependency>
-                <groupId>org.opendaylight.yangtools</groupId>
-                <artifactId>yangtools-docs</artifactId>
-                <version>2.0.9-SNAPSHOT</version>
-                <classifier>javadoc</classifier>
-            </dependency>
-            <dependency>
-                <groupId>org.opendaylight.yangtools</groupId>
-                <artifactId>yangtools-docs</artifactId>
-                <version>2.0.9-SNAPSHOT</version>
-                <classifier>sources</classifier>
             </dependency>
         </dependencies>
     </dependencyManagement>

diff --git a/docs/pom.xml b/docs/pom.xml
index d07eb04bde2f20636863cbf9a67293ebbf373f16..4b1def6d615ceeb4f40a79f390fa5e0a8b42d064 100644 (file)
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -208,25 +208,25 @@
     <build>
         <plugins>
             <plugin>
-                               <groupId>org.asciidoctor</groupId>
+                <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
                 <version>1.5.7.1</version>
                 <executions>
-                                       <execution>
-                                               <id>output-html</id>
-                                               <phase>generate-resources</phase>
-                                               <goals>
-                                                       <goal>process-asciidoc</goal>
-                                               </goals>
-                                               <configuration>
-                                                       <sourceHighlighter>coderay</sourceHighlighter>
-                                                       <backend>html</backend>
-                                                       <attributes>
-                                                               <toc/>
-                                                               <linkcss>false</linkcss>
-                                                       </attributes>
-                                               </configuration>
-                                       </execution>
+                    <execution>
+                        <id>output-html</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>process-asciidoc</goal>
+                        </goals>
+                        <configuration>
+                            <sourceHighlighter>coderay</sourceHighlighter>
+                            <backend>html</backend>
+                            <attributes>
+                                <toc/>
+                                <linkcss>false</linkcss>
+                            </attributes>
+                        </configuration>
+                    </execution>
                 </executions>
                 <configuration>
                     <attributes>
@@ -237,37 +237,12 @@
                 </configuration>
             </plugin>
 
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-assembly-plugin</artifactId>
-                <configuration>
-                    <descriptor>assembly/guides.xml</descriptor>
-                </configuration>
-                <executions>
-                    <execution>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>single</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
-            <plugin>
-                <!-- We do not want the jar to be created -->
-                <artifactId>maven-jar-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>default-jar</id>
-                        <phase>none</phase>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <artifactId>maven-dependency-plugin</artifactId>
                 <executions>
                     <execution>
                         <id>unpack-sources</id>
-                        <phase>prepare-package</phase>
+                        <phase>process-classes</phase>
                         <goals>
                             <goal>unpack-dependencies</goal>
                         </goals>
@@ -281,14 +256,13 @@
                     </execution>
                 </executions>
             </plugin>
-
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>build-helper-maven-plugin</artifactId>
                 <executions>
                     <execution>
                         <id>add-source</id>
-                        <phase>prepare-package</phase>
+                        <phase>process-classes</phase>
                         <goals>
                             <goal>add-source</goal>
                         </goals>
@@ -301,6 +275,20 @@
                 </executions>
             </plugin>
 
+            <plugin>
+                <artifactId>maven-source-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <!-- prepare-package so we build the source package before javadoc -->
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
             <plugin>
                 <artifactId>maven-javadoc-plugin</artifactId>
                     <!-- FIXME: remove override once odlparent ships 3.1.0+ -->
@@ -320,14 +308,41 @@
                         <link>http://hamcrest.org/JavaHamcrest/javadoc/1.3/</link>
                         <link>http://google.github.io/truth/api/0.42/</link>
                         <link>https://www.slf4j.org/apidocs/</link>
-                        <link>https://xerces.apache.org/xerces2-j/javadocs/api/</link>
                         <link>https://google.github.io/guava/releases/25.1-jre/api/docs/</link>
-                        <link>http://doc.akka.io/japi/akka/2.5.19/</link>
-                        <link>http://netty.io/4.1/api/</link>
                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/</link>
                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-3.8.1/</link>
                         <link>https://commons.apache.org/proper/commons-codec/apidocs/</link>
                     </links>
+                    <groups>
+                        <group>
+                            <title>Common concepts</title>
+                            <packages>org.opendaylight.yangtools.concepts*</packages>
+                        </group>
+                        <group>
+                            <title>Common utilities</title>
+                            <packages>org.opendaylight.yangtools.util*</packages>
+                        </group>
+                        <group>
+                            <title>Common YANG constructs</title>
+                            <packages>org.opendaylight.yangtools.yang.common*</packages>
+                        </group>
+                        <group>
+                            <title>YANG schema interfaces</title>
+                            <packages>org.opendaylight.yangtools.yang.model.api*:org.opendaylight.yangtools.yang.model.util*</packages>
+                        </group>
+                        <group>
+                            <title>YANG data tree interfaces</title>
+                            <packages>org.opendaylight.yangtools.yang.data.api*:org.opendaylight.yangtools.yang.data.util*</packages>
+                        </group>
+                        <group>
+                            <title>yang-maven-plugin codegen interface</title>
+                            <packages>org.opendaylight.yangtools.yang2sources.spi*</packages>
+                        </group>
+                        <group>
+                            <title>Common YANG parser</title>
+                            <packages>org.opendaylight.yangtools.yang.parser*</packages>
+                        </group>
+                    </groups>
                 </configuration>
             </plugin>
         </plugins>