mirror of
https://github.com/corda/corda.git
synced 2024-12-19 04:57:58 +00:00
81 lines
3.0 KiB
Groovy
81 lines
3.0 KiB
Groovy
import org.apache.tools.ant.taskdefs.condition.Os
|
|
|
|
import java.nio.file.Files
|
|
|
|
apply plugin: 'org.jetbrains.dokka'
|
|
apply plugin: 'kotlin'
|
|
|
|
dependencies {
|
|
compile rootProject
|
|
}
|
|
|
|
def internalPackagePrefixes(sourceDirs) {
|
|
def prefixes = []
|
|
// Kotlin allows packages to deviate from the directory structure, but let's assume they don't:
|
|
sourceDirs.collect { sourceDir ->
|
|
sourceDir.traverse(type: groovy.io.FileType.DIRECTORIES) {
|
|
if (it.name == 'internal') {
|
|
prefixes.add sourceDir.toPath().relativize(it.toPath()).toString().replace(File.separator, '.')
|
|
}
|
|
}
|
|
}
|
|
prefixes
|
|
}
|
|
|
|
ext {
|
|
// TODO: Add '../client/jfx/src/main/kotlin' and '../client/mock/src/main/kotlin' if we decide to make them into public API
|
|
dokkaSourceDirs = files('../core/src/main/kotlin', '../client/rpc/src/main/kotlin', '../finance/workflows/src/main/kotlin', '../finance/contracts/src/main/kotlin', '../client/jackson/src/main/kotlin',
|
|
'../testing/test-utils/src/main/kotlin', '../testing/node-driver/src/main/kotlin')
|
|
internalPackagePrefixes = internalPackagePrefixes(dokkaSourceDirs)
|
|
}
|
|
|
|
dokka {
|
|
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/kotlin")
|
|
}
|
|
|
|
task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) {
|
|
outputFormat = "javadoc"
|
|
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/javadoc")
|
|
}
|
|
|
|
[dokka, dokkaJavadoc].collect {
|
|
it.configure {
|
|
moduleName = 'corda'
|
|
processConfigurations = ['compile']
|
|
sourceDirs = dokkaSourceDirs
|
|
includes = ['packages.md']
|
|
jdkVersion = 8
|
|
externalDocumentationLink {
|
|
url = new URL("http://fasterxml.github.io/jackson-core/javadoc/2.9/")
|
|
}
|
|
externalDocumentationLink {
|
|
url = new URL("https://docs.oracle.com/javafx/2/api/")
|
|
}
|
|
externalDocumentationLink {
|
|
url = new URL("http://www.bouncycastle.org/docs/docs1.5on/")
|
|
}
|
|
internalPackagePrefixes.collect { packagePrefix ->
|
|
packageOptions {
|
|
prefix = packagePrefix
|
|
suppress = true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
task buildDocs(dependsOn: ['apidocs', 'makeDocs'])
|
|
task apidocs(dependsOn: ['dokka', 'dokkaJavadoc'])
|
|
|
|
task makeDocs(type: Exec) {
|
|
// 2 volumes are mounted:
|
|
// - the docs project to /opt/docs_builder, where docs building is executed
|
|
// - the rest of the projects in /opt, so that code references to other projects are valid
|
|
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
|
|
commandLine "docker", "run", "--rm", "-v", "${project.projectDir}:/opt/docs_builder", "-v", "${project.projectDir}/..:/opt", "corda/docs-builder:latest", "bash", "-c", "make-docsite.sh"
|
|
} else {
|
|
commandLine "bash", "-c", "docker run --rm --user \$(id -u):\$(id -g) -v ${project.projectDir}:/opt/docs_builder -v ${project.projectDir}/..:/opt corda/docs-builder:latest bash -c make-docsite.sh"
|
|
}
|
|
}
|
|
|
|
apidocs.shouldRunAfter makeDocs
|