ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-26 16:11:12 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
1723838a59
corda/docs/build.gradle

63 lines
2.4 KiB
Groovy
Raw Normal View History

Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
apply plugin: 'org.jetbrains.dokka'
Removed old information about Dokka from the building docs documentation. Make docsite no longer cleans. Now gradle should be used for cleaning the docs. Corrected docs building gradle script.
2017-03-28 15:12:38 +00:00
apply plugin: 'kotlin'
dependencies {
compile rootProject
}
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
dokka {
moduleName = 'corda'
Removed old information about Dokka from the building docs documentation. Make docsite no longer cleans. Now gradle should be used for cleaning the docs. Corrected docs building gradle script.
2017-03-28 15:12:38 +00:00
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/kotlin")
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
processConfigurations = ['compile']
Add testing classes to Dokka (#1507)
2017-09-14 11:55:23 +00:00
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node-api/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin', '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin')
Merge "A variety of small fixes" into the 1.0 release branch (#1673) * Minor: improve javadocs in NodeInfo * Minor: use package descriptions in Kotlin build of api docs too, not just javadocs. * RPC: make RPCConnection non-internal, as it's a core API. Move docs around so they're on public API not internal API. * Add an IntelliJ scope that covers the currently supported Corda API. This is useful when used in combination with the "Highlight public declarations with missing KDoc" inspection. * Ironic: upgrade the version of the Gradle plugin that checks for upgraded versions of things. It had broken due being incompatible with the new versions of Gradle itself. * Docs: flesh out javadocs on ServiceHub * Docs: add @suppress to a few things that were polluting the Dokka docs. * Docs: mention RPC access in NodeInfo javadoc
2017-09-27 10:39:41 +00:00
includes = ['packages.md']
Update Dokka configuration * Switch documentation JDK version to 8 * Add node-api package to Dokka includes * Remove node package from Dokka includes
2017-08-30 13:53:37 +00:00
jdkVersion = 8
Add external documentation Add references to Bouncy Castle, Jackson and JavaFX documentation for Dokka to link to.
2017-09-04 10:33:21 +00:00
externalDocumentationLink {
url = new URL("http://fasterxml.github.io/jackson-core/javadoc/2.8/")
}
externalDocumentationLink {
url = new URL("https://docs.oracle.com/javafx/2/api/")
}
externalDocumentationLink {
url = new URL("http://www.bouncycastle.org/docs/docs1.5on/")
}
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
}
task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
moduleName = 'corda'
outputFormat = "javadoc"
Removed old information about Dokka from the building docs documentation. Make docsite no longer cleans. Now gradle should be used for cleaning the docs. Corrected docs building gradle script.
2017-03-28 15:12:38 +00:00
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/javadoc")
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
processConfigurations = ['compile']
Add testing classes to Dokka (#1507)
2017-09-14 11:55:23 +00:00
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node-api/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin', '../testing/node-driver/src/main/kotlin', '../testing/test-utils/src/main/kotlin')
Move some extension methods for summing to new locations. This improves the Java API and makes it more idiomatic. The methods were not moved to be static methods of the relevant types in all cases due to a bad interaction with a Kotlin auto-completion bug, and because static methods on interfaces are new in Java 8 and Kotlin is not yet emitting Java 8 bytecode. Also, introduce a packages.md file so packages can be documented.
2017-08-17 11:12:20 +00:00
includes = ['packages.md']
Update Dokka configuration * Switch documentation JDK version to 8 * Add node-api package to Dokka includes * Remove node package from Dokka includes
2017-08-30 13:53:37 +00:00
jdkVersion = 8
Add external documentation Add references to Bouncy Castle, Jackson and JavaFX documentation for Dokka to link to.
2017-09-04 10:33:21 +00:00
externalDocumentationLink {
url = new URL("http://fasterxml.github.io/jackson-core/javadoc/2.8/")
}
externalDocumentationLink {
url = new URL("https://docs.oracle.com/javafx/2/api/")
}
externalDocumentationLink {
url = new URL("http://www.bouncycastle.org/docs/docs1.5on/")
}
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
}
Removed robots.txt from repo and added docs/build back to the gitignore list.
2017-03-28 13:59:16 +00:00
task buildDocs(dependsOn: ['apidocs', 'makeDocs'])
Removed old information about Dokka from the building docs documentation. Make docsite no longer cleans. Now gradle should be used for cleaning the docs. Corrected docs building gradle script.
2017-03-28 15:12:38 +00:00
task apidocs(dependsOn: ['dokka', 'dokkaJavadoc'])
task makeDocs(type: Exec, dependsOn: ['installDocsiteRequirements']) {
// TODO: Non-msys Windows script
Fixed docsite building on Ubuntu by explicitly calling bash. Due to sh mapping to dash and not bash.
2017-04-03 15:45:55 +00:00
commandLine 'cmd', '/c', 'bash make-docsite.sh' // Windows
commandLine 'bash', './make-docsite.sh' // Linux
Removed old information about Dokka from the building docs documentation. Make docsite no longer cleans. Now gradle should be used for cleaning the docs. Corrected docs building gradle script.
2017-03-28 15:12:38 +00:00
}
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
task installDocsiteRequirements(type: Exec) {
Removed docs build directory from repo. Make docsite is back in a shell file due to issues invokving outside of the virtualenv.
2017-03-24 16:23:12 +00:00
// TODO: Non-msys Windows script
Fixed docsite building on Ubuntu by explicitly calling bash. Due to sh mapping to dash and not bash.
2017-04-03 15:45:55 +00:00
commandLine 'cmd', '/c', 'bash install-docsite-requirements.sh' // Windows
commandLine 'bash', './install-docsite-requirements.sh' // Linux
Moved the build docs functionality into build.gradle. Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
2017-03-24 14:43:45 +00:00
}
Fixed docsite building on Ubuntu by explicitly calling bash. Due to sh mapping to dash and not bash.
2017-04-03 15:45:55 +00:00
apidocs.shouldRunAfter makeDocs
Reference in New Issue Copy Permalink