如何将聚合的javadoc部署到github

时间:2012-04-09 15:18:16

标签: maven github

我使用github site-maven-plugin来部署我的网站文档:

https://github.com/github/maven-plugins

但是我有一个多模块项目,它似乎只部署单个模块,而不是整个聚合站点。如何部署聚合的站点文档?

这是我的maven插件:

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <configuration>
                <aggregate>true</aggregate>
                <author>true</author>
                <bottom>true</bottom>
                <destDir>javadoc</destDir>
                <!-- <header><![CDATA[<a href="/" target="_top">Spring Utility</a>]]></header> -->
                <header><![CDATA[<a href="/" target="_top">${project.description}</a>]]></header>
                <minmemory>128m</minmemory>
                <maxmemory>512</maxmemory>
                <overview>${site.basedir}/src/main/javadoc/overview.html</overview>
                <packagenames>com.baselogic.*</packagenames>
                <use>true</use>
                <version>true</version>
                <windowtitle>${project.name} ${project.version} API</windowtitle>
                <doclet>ydoc.doclets.YStandard</doclet>
                <docletPath>${site.basedir}/src/yworks/ydoc.jar;${site.basedir}/src/yworks/styleed.jar;${site.basedir}/src/yworks/resources;${build.classes.dir};</docletPath>
                <additionalparam>-umlautogen -link http://docs.oracle.com/javase/6/docs/api/</additionalparam>
                <tag name="noinspection" description="IntelliJ Inspection Ignore tag"
                    enabled="false" />

                <doctitle>API for ${project.name} ${project.version}</doctitle> <!-- Used by javadoc:javadoc goal -->
                <windowtitle>API for ${project.name} ${project.version}</windowtitle> <!-- Used by javadoc:javadoc goal -->

                <testDoctitle>Test API for ${project.name} ${project.version}</testDoctitle> <!-- Used by javadoc:test-javadoc goal -->
                <testWindowtitle>Test API for ${project.name} ${project.version}</testWindowtitle> <!-- Used by javadoc:test-javadoc goal -->                

            </configuration>

            <reportSets>
                <reportSet>
                    <id>html</id>
                    <configuration>
                        <doctitle>API for ${project.name} ${project.version}</doctitle>
                        <windowtitle>API for ${project.name} ${project.version}</windowtitle>
                    </configuration>
                    <reports>
                        <report>aggregate</report>
                        <!-- <report>javadoc</report>
                        <report>test-javadoc</report> -->
                    </reports>
                </reportSet>
                <reportSet>
                    <id>test-html</id>
                    <configuration>
                        <testDoctitle>Test API for ${project.name} ${project.version}</testDoctitle>
                        <testWindowtitle>Test API for ${project.name} ${project.version}</testWindowtitle>
                    </configuration>
                    <reports>
                        <report>aggregate</report>
                        <!-- <report>test-javadoc</report> -->
                    </reports>
                </reportSet>
            </reportSets>                  

        </plugin>

我自己的服务器上的网站看起来很好: http://baselogic.com/code/SpringCertification/

但是Github仍然只是最后一个模块: http://mickknutson.github.com/SpringCertification/

1 个答案:

答案 0 :(得分:0)

尝试使用aggregate goal of the javadoc plugin并将其绑定到“网站”阶段。然后发布到github的任何内容应该包括所有子模块