Build and documentation minor edits
Project: http://git-wip-us.apache.org/repos/asf/zest-qi4j/repo Commit: http://git-wip-us.apache.org/repos/asf/zest-qi4j/commit/5a1a63bb Tree: http://git-wip-us.apache.org/repos/asf/zest-qi4j/tree/5a1a63bb Diff: http://git-wip-us.apache.org/repos/asf/zest-qi4j/diff/5a1a63bb Branch: refs/heads/develop Commit: 5a1a63bbe49fc34f796d4bfed3de64a63ecdaae2 Parents: 8c580cd Author: Paul Merlin <[email protected]> Authored: Thu Jul 16 22:11:44 2015 +0200 Committer: Paul Merlin <[email protected]> Committed: Thu Jul 16 23:49:26 2015 +0200 ---------------------------------------------------------------------- build.gradle | 4 +- buildSrc/src/javadoc/overview.html | 23 ---------- .../org/qi4j/gradle/plugin/Documentation.groovy | 45 ++++++++++---------- libraries/metrics/src/docs/metrics.txt | 2 +- src/javadoc/overview.html | 23 ++++++++++ 5 files changed, 48 insertions(+), 49 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/5a1a63bb/build.gradle ---------------------------------------------------------------------- diff --git a/build.gradle b/build.gradle index f1e1431..b164793 100644 --- a/build.gradle +++ b/build.gradle @@ -516,7 +516,7 @@ task javadocs( type: Javadoc ) { options.docFilesSubDirs = true options.encoding = "UTF-8" - options.overview = "${rootProject.projectDir}/buildSrc/src/javadoc/overview.html" + options.overview = "${rootProject.projectDir}/src/javadoc/overview.html" title = "${rootProject.title} ${version}" def apiSources = releaseApprovedProjects.findAll( { project -> ( project.name.startsWith( 'org.qi4j.core' ) && !project.name.startsWith( 'org.qi4j.core.runtime' ) ) || @@ -780,7 +780,7 @@ task unpackSrcDist( type: Copy ) { } task checkSrcDist( type: GradleBuild, dependsOn: unpackSrcDist ) { buildFile = "$unpackedSrcDistDir/build.gradle" - tasks = [ 'check' ] // TODO check + tasks = [ 'check' ] } task unpackBinDist( type: Copy, dependsOn: buildAll ) { with binDistImage http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/5a1a63bb/buildSrc/src/javadoc/overview.html ---------------------------------------------------------------------- diff --git a/buildSrc/src/javadoc/overview.html b/buildSrc/src/javadoc/overview.html deleted file mode 100644 index 38affee..0000000 --- a/buildSrc/src/javadoc/overview.html +++ /dev/null @@ -1,23 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<html> - <body> - <h3>Welcome to the Apache Zest⢠(Java Edition) SDK Javadoc.</h3> - <p>Apache Zest⢠is a framework for domain centric application development, including evolved concepts from AOP, DI and DDD.</p> - <p><a href="https://zest.apache.org"; target="_blank">zest.apache.org</a></p> - </body> -</html> http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/5a1a63bb/buildSrc/src/main/groovy/org/qi4j/gradle/plugin/Documentation.groovy ---------------------------------------------------------------------- diff --git a/buildSrc/src/main/groovy/org/qi4j/gradle/plugin/Documentation.groovy b/buildSrc/src/main/groovy/org/qi4j/gradle/plugin/Documentation.groovy index bf2a416..a6e6bf5 100644 --- a/buildSrc/src/main/groovy/org/qi4j/gradle/plugin/Documentation.groovy +++ b/buildSrc/src/main/groovy/org/qi4j/gradle/plugin/Documentation.groovy @@ -61,14 +61,14 @@ class Documentation extends DefaultTask new File(project.buildDir, "docs/$docName".toString()).mkdirs() new File(project.buildDir, "tmp/docs/$docName".toString()).mkdirs() - copyResources() + copySubProjectsResources() generateXDoc() generateChunkedHtml() - generateSingleHtml() - generatePdf() + // generateSingleHtml() + // generatePdf() } - def void copyResources() + def void copySubProjectsResources() { project.parent.subprojects.each { p -> p.copy { @@ -153,26 +153,25 @@ class Documentation extends DefaultTask def void generatePdf() { -// $ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml > article.fo + // $ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml > article.fo // $ fop article.fo article.pdf - - // project.exec { - // String xsltFile = 'src/xsl/fo.xsl' - // executable = 'xsltproc' - // args = [ - // '--nonet', - // '--output', "build/tmp/docs/$docName/$docName"+".fo", - // xsltFile, - // "build/tmp/docs/$docName/xdoc-temp.xml" - // ] - // } - // project.exec { - // executable = 'fop' - // args = [ - // "build/tmp/docs/$docName/$docName"+".fo", - // "build/docs/$docName/$docName" + ".pdf" - // ] - // } + project.exec { + String xsltFile = 'src/xsl/fo.xsl' + executable = 'xsltproc' + args = [ + '--nonet', + '--output', "build/tmp/docs/$docName/$docName"+".fo", + xsltFile, + "build/tmp/docs/$docName/xdoc-temp.xml" + ] + } + project.exec { + executable = 'fop' + args = [ + "build/tmp/docs/$docName/$docName"+".fo", + "build/docs/$docName/$docName" + ".pdf" + ] + } } String getDocName( ) http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/5a1a63bb/libraries/metrics/src/docs/metrics.txt ---------------------------------------------------------------------- diff --git a/libraries/metrics/src/docs/metrics.txt b/libraries/metrics/src/docs/metrics.txt index 7ac1061..857c99a 100644 --- a/libraries/metrics/src/docs/metrics.txt +++ b/libraries/metrics/src/docs/metrics.txt @@ -14,7 +14,7 @@ ////////////////////// [[library-metrics,Metrics Library]] -= Metrics Library= += Metrics Library = The Metrics library is available to application code to get production metrics from their applications. It allows applications to easily mark critical section for metrics gathering, without handling the details with the Metrics http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/5a1a63bb/src/javadoc/overview.html ---------------------------------------------------------------------- diff --git a/src/javadoc/overview.html b/src/javadoc/overview.html new file mode 100644 index 0000000..38affee --- /dev/null +++ b/src/javadoc/overview.html @@ -0,0 +1,23 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + <body> + <h3>Welcome to the Apache Zest⢠(Java Edition) SDK Javadoc.</h3> + <p>Apache Zest⢠is a framework for domain centric application development, including evolved concepts from AOP, DI and DDD.</p> + <p><a href="https://zest.apache.org"; target="_blank">zest.apache.org</a></p> + </body> +</html>
