forked from corda/corda
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removed old information about Dokka from the building docs documentat…
…ion. Make docsite no longer cleans. Now gradle should be used for cleaning the docs. Corrected docs building gradle script.
- Loading branch information
Showing
3 changed files
with
25 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,47 @@ | ||
apply plugin: 'org.jetbrains.dokka' | ||
apply plugin: 'kotlin' | ||
|
||
repositories { | ||
mavenLocal() | ||
mavenCentral() | ||
jcenter() | ||
maven { | ||
url 'https://dl.bintray.com/kotlin/exposed' | ||
} | ||
} | ||
|
||
dependencies { | ||
compile rootProject | ||
} | ||
|
||
dokka { | ||
moduleName = 'corda' | ||
outputDirectory = 'docs/build/html/api/kotlin' | ||
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/kotlin") | ||
processConfigurations = ['compile'] | ||
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin') | ||
} | ||
|
||
task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) { | ||
moduleName = 'corda' | ||
outputFormat = "javadoc" | ||
outputDirectory = 'docs/build/html/api/javadoc' | ||
outputDirectory = file("${rootProject.rootDir}/docs/build/html/api/javadoc") | ||
processConfigurations = ['compile'] | ||
sourceDirs = files('../core/src/main/kotlin', '../client/jfx/src/main/kotlin', '../client/mock/src/main/kotlin', '../client/rpc/src/main/kotlin', '../node/src/main/kotlin', '../finance/src/main/kotlin', '../client/jackson/src/main/kotlin') | ||
} | ||
|
||
task apidocs(dependsOn: [':jar', 'dokka', 'dokkaJavadoc']) | ||
task buildDocs(dependsOn: ['apidocs', 'makeDocs']) | ||
task apidocs(dependsOn: ['dokka', 'dokkaJavadoc']) | ||
|
||
task makeDocs(type: Exec, dependsOn: ['installDocsiteRequirements']) { | ||
// TODO: Non-msys Windows script | ||
commandLine 'cmd', '/c', 'sh make-docsite.sh' // Windows | ||
commandLine 'sh', './make-docsite.sh' // Linux | ||
} | ||
|
||
task installDocsiteRequirements(type: Exec) { | ||
// TODO: Non-msys Windows script | ||
commandLine 'cmd', '/c', 'sh install-docsite-requirements.sh' // Windows | ||
commandLine 'sh', './install-docsite-requirements.sh' // Linux | ||
} | ||
|
||
task makeDocs(type: Exec, dependsOn: ['installDocsiteRequirements']) { | ||
// TODO: Non-msys Windows script | ||
commandLine 'cmd', '/c', 'sh make-docsite.sh' // Windows | ||
commandLine 'sh', './make-docsite.sh' // Linux | ||
} | ||
apidocs.shouldRunAfter makeDocs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,4 +11,4 @@ else | |
source virtualenv/Scripts/activate | ||
fi | ||
|
||
make clean html | ||
make html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters