Skip to content

Commit

Permalink
Add support for multiple versions with Dokka (Kotlin#238)
Browse files Browse the repository at this point in the history
* Fixed face alignment API

* Fixed KDocs

* Fixed examples

* Fixed KDocs for the examples

* Added Faces test

* Fixed imports

* Fixed imports

* Changed dokka gradle script to the versioning support

* Updated dokka for multiple-version support
  • Loading branch information
zaleslaw authored Sep 23, 2021
1 parent 677b963 commit 62401d0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
3 changes: 1 addition & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ plugins {
id 'org.jetbrains.kotlin.jvm' version '1.5.21'
id 'maven'
id 'io.codearte.nexus-staging' version '0.22.0'
id 'org.jetbrains.dokka' version '1.5.0'

id 'org.jetbrains.dokka' version '1.5.30'
}

apply plugin: "io.codearte.nexus-staging"
Expand Down
6 changes: 6 additions & 0 deletions dokka/moduledoc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Module api
Core API.

# Module dataset
Basic Dataset API and Image Preprocessing DSL

# Module onnx
ONNX model support

# Module visualization
Visualisation with lets-plot and Swing.

Expand Down
13 changes: 10 additions & 3 deletions gradle/dokka.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
* Copyright 2020 JetBrains s.r.o. and Kotlin Deep Learning project contributors. All Rights Reserved.
* Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE.txt file.
*/

apply plugin: 'kotlin'
apply plugin: 'org.jetbrains.dokka'

def documentedSubprojects = ["api",
"visualization"]
def documentedSubprojects = ["api", "dataset", "onnx", "visualization"]
subprojects {
if (!(name in documentedSubprojects)) return
apply plugin: 'org.jetbrains.dokka'
Expand All @@ -27,3 +25,12 @@ subprojects {
}
}



tasks.named('dokkaHtmlMultiModule') {
def configuredVersion = "0.3"
def olderVersionsDir = "older_versions"
pluginsMapConfiguration.set(["org.jetbrains.dokka.versioning.VersioningPlugin" : """{ "version": "$configuredVersion", "olderVersionsDir":"$olderVersionsDir"}"""])
}


0 comments on commit 62401d0

Please sign in to comment.