Skip to content

Commit

Permalink
Removed old information about Dokka from the building docs documentat…
Browse files Browse the repository at this point in the history
…ion.

Make docsite no longer cleans. Now gradle should be used for cleaning the docs.

Corrected docs building gradle script.
  • Loading branch information
Clintonio committed Mar 30, 2017
1 parent 1b5182f commit 5ef66d8
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 17 deletions.
32 changes: 24 additions & 8 deletions docs/build.gradle
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
2 changes: 1 addition & 1 deletion docs/make-docsite.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ else
source virtualenv/Scripts/activate
fi

make clean html
make html
8 changes: 0 additions & 8 deletions docs/source/building-the-docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 5ef66d8

Please sign in to comment.