mirror of
https://github.com/corda/corda.git
synced 2025-02-21 09:51:57 +00:00
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.
This commit is contained in:
parent
1b5182fe24
commit
5ef66d8fd6
@ -1,8 +1,22 @@
|
||||
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')
|
||||
}
|
||||
@ -10,13 +24,19 @@ dokka {
|
||||
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
|
||||
@ -24,8 +44,4 @@ task installDocsiteRequirements(type: Exec) {
|
||||
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
|
@ -11,4 +11,4 @@ else
|
||||
source virtualenv/Scripts/activate
|
||||
fi
|
||||
|
||||
make clean html
|
||||
make html
|
@ -11,17 +11,9 @@ To build the documentation, you will need:
|
||||
|
||||
* GNU Make
|
||||
* Python and pip (tested with Python 2.7.10)
|
||||
* Dokka: https://github.com/Kotlin/dokka
|
||||
* Sphinx: http://www.sphinx-doc.org/
|
||||
* sphinx_rtd_theme: https://github.com/snide/sphinx_rtd_theme
|
||||
|
||||
The Dokka JAR file needs to be placed under the ``lib`` directory within the ``r3prototyping`` directory, in order for the
|
||||
script to find it, as in:
|
||||
|
||||
.. sourcecode:: shell
|
||||
|
||||
corda/lib/dokka.jar
|
||||
|
||||
Note that to install under OS X El Capitan, you will need to tell pip to install under ``/usr/local``, which can be
|
||||
done by specifying the installation target on the command line:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user