Merge pull request #256 from mipt-npm/commandertvis/dokka-links

Improve Dokka configuration

README.md

@@ -1,9 +1,8 @@
 [![JetBrains Research](https://jb.gg/badges/research.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 [![DOI](https://zenodo.org/badge/129486382.svg)](https://zenodo.org/badge/latestdoi/129486382)
-
 ![Gradle build](https://github.com/mipt-npm/kmath/workflows/Gradle%20build/badge.svg)
-
+[![Maven Central](https://img.shields.io/maven-central/v/space.kscience/kmath-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22space.kscience%22)
-[![Maven Central](https://img.shields.io/maven-central/v/space.kscience/kmath-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22space.kscience%22%20AND%20a:%22kmath-core%22)
+[![Space](https://img.shields.io/maven-metadata/v?label=Space&metadataUrl=https%3A%2F%2Fmaven.pkg.jetbrains.space%2Fmipt-npm%2Fp%2Fsci%2Fmaven%2Fkscience%2Fkmath%2Fkmath-core%2Fmaven-metadata.xml)](https://maven.pkg.jetbrains.space/mipt-npm/p/sci/maven/space/kscience/)
 
 # KMath
 
@@ -147,6 +146,12 @@ performance calculations to code generation.
 > 
 >
 > **Maturity**: PROTOTYPE
+>
+> **Features:**
+> - [ejml-vector](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlVector.kt) : The Point implementation using SimpleMatrix.
+> - [ejml-matrix](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlMatrix.kt) : The Matrix implementation using SimpleMatrix.
+> - [ejml-linear-space](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlLinearSpace.kt) : The LinearSpace implementation using SimpleMatrix.
+
 <hr/>
 
 * ### [kmath-for-real](kmath-for-real)

build.gradle.kts

@@ -1,4 +1,6 @@
+import org.jetbrains.dokka.gradle.DokkaTask
 import ru.mipt.npm.gradle.KSciencePublishingPlugin
+import java.net.URL
 
 plugins {
     id("ru.mipt.npm.gradle.project")
@@ -9,7 +11,6 @@ allprojects {
         jcenter()
         maven("https://clojars.org/repo")
         maven("https://dl.bintray.com/egor-bogomolov/astminer/")
-        maven("https://dl.bintray.com/hotkeytlt/maven")
         maven("https://dl.bintray.com/kotlin/kotlin-eap")
         maven("https://dl.bintray.com/kotlin/kotlinx")
         maven("https://dl.bintray.com/mipt-npm/dev")
@@ -25,6 +26,27 @@ allprojects {
 
 subprojects {
     if (name.startsWith("kmath")) apply<KSciencePublishingPlugin>()
+
+    afterEvaluate {
+        tasks.withType<DokkaTask> {
+            dokkaSourceSets.all {
+                val readmeFile = File(this@subprojects.projectDir, "./README.md")
+                if (readmeFile.exists())
+                    includes.setFrom(includes + readmeFile.absolutePath)
+
+                arrayOf(
+                    "http://ejml.org/javadoc/",
+                    "https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/",
+                    "https://deeplearning4j.org/api/latest/"
+                ).map { URL("${it}package-list") to URL(it) }.forEach { (a, b) ->
+                    externalDocumentationLink {
+                        packageListUrl.set(a)
+                        url.set(b)
+                    }
+                }
+            }
+        }
+    }
 }
 
 readme {

docs/templates/ARTIFACT-TEMPLATE.md

@@ -1,34 +1,28 @@
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `${group}:${name}:${version}`.
+The Maven coordinates of this project are `${group}:${name}:${version}`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/${name}/images/download.svg) ](https://bintray.com/mipt-npm/kscience/${name}/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/${name}/images/download.svg) ](https://bintray.com/mipt-npm/dev/${name}/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation '${group}:${name}:${version}'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation '${group}:${name}:${version}'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("${group}:${name}:${version}")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("${group}:${name}:${version}")
-> }
-> ```

docs/templates/README-TEMPLATE.md

@@ -1,9 +1,8 @@
 [![JetBrains Research](https://jb.gg/badges/research.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 [![DOI](https://zenodo.org/badge/129486382.svg)](https://zenodo.org/badge/latestdoi/129486382)
-
 ![Gradle build](https://github.com/mipt-npm/kmath/workflows/Gradle%20build/badge.svg)
-
+[![Maven Central](https://img.shields.io/maven-central/v/space.kscience/kmath-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22space.kscience%22)
-[![Maven Central](https://img.shields.io/maven-central/v/space.kscience/kmath-core.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22space.kscience%22%20AND%20a:%22kmath-core%22)
+[![Space](https://img.shields.io/maven-metadata/v?label=Space&metadataUrl=https%3A%2F%2Fmaven.pkg.jetbrains.space%2Fmipt-npm%2Fp%2Fsci%2Fmaven%2Fkscience%2Fkmath%2Fkmath-core%2Fmaven-metadata.xml)](https://maven.pkg.jetbrains.space/mipt-npm/p/sci/maven/space/kscience/)
 
 # KMath
 

gradle.properties

@@ -4,5 +4,5 @@ kotlin.mpp.stability.nowarn=true
 kotlin.native.enableDependencyPropagation=false
 kotlin.parallel.tasks.in.project=true
 org.gradle.configureondemand=true
-org.gradle.jvmargs=-XX:MaxMetaspaceSize=2G
+org.gradle.jvmargs=-XX:MaxMetaspaceSize=9G
 org.gradle.parallel=true

kmath-ast/README.md

@@ -1,6 +1,6 @@
-# Abstract Syntax Tree Expression Representation and Operations (`kmath-ast`)
+# Module kmath-ast
 
-This subproject implements the following features:
+Abstract syntax tree expression representation and related optimizations.
 
  - [expression-language](src/jvmMain/kotlin/space/kscience/kmath/ast/parser.kt) : Expression language and its parser
  - [mst](src/commonMain/kotlin/space/kscience/kmath/ast/MST.kt) : MST (Mathematical Syntax Tree) as expression language's syntax intermediate representation
@@ -10,40 +10,34 @@ This subproject implements the following features:
  - [mst-js-codegen](src/jsMain/kotlin/space/kscience/kmath/estree/estree.kt) : Dynamic MST to JS compiler
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-ast:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-ast:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-ast/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-ast/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-ast/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-ast/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-ast:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-ast:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-ast:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-ast:0.3.0-dev-3")
-> }
-> ```
 
 ## Dynamic expression code generation
 

kmath-ast/docs/README-TEMPLATE.md

@@ -1,6 +1,6 @@
-# Abstract Syntax Tree Expression Representation and Operations (`kmath-ast`)
+# Module kmath-ast
 
-This subproject implements the following features:
+Abstract syntax tree expression representation and related optimizations.
 
 ${features}
 

kmath-complex/README.md

@@ -1,42 +1,36 @@
-# The Core Module (`kmath-core`)
+# Module kmath-complex
 
-Complex and hypercomplex number systems in KMath:
+Complex and hypercomplex number systems in KMath.
 
  - [complex](src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex Numbers
  - [quaternion](src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-complex:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-complex:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-complex/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-complex/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-complex/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-complex/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-complex:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-complex:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-complex:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-complex:0.3.0-dev-3")
-> }
-> ```

kmath-complex/docs/README-TEMPLATE.md

@@ -1,6 +1,6 @@
-# The Core Module (`kmath-core`)
+# Module kmath-complex
 
-Complex and hypercomplex number systems in KMath:
+Complex and hypercomplex number systems in KMath.
 
 ${features}
 

kmath-core/README.md

@@ -1,6 +1,6 @@
-# The Core Module (`kmath-core`)
+# Module kmath-core
 
-The core features of KMath:
+The core interfaces of KMath.
 
  - [algebras](src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Algebraic structures like rings, spaces and fields.
  - [nd](src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt) : Many-dimensional structures and operations on them.
@@ -13,37 +13,31 @@ performance calculations to code generation.
  - [autodif](src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic differentiation
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-core:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-core:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-core/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-core/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-core/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-core/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-core:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-core:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-core:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-core:0.3.0-dev-3")
-> }
-> ```

kmath-core/docs/README-TEMPLATE.md

@@ -1,6 +1,6 @@
-# The Core Module (`kmath-core`)
+# Module kmath-core
 
-The core features of KMath:
+The core interfaces of KMath.
 
 ${features}
 

kmath-ejml/README.md

@@ -1,43 +1,37 @@
-# ejml-simple support (`kmath-ejml`)
+# Module kmath-ejml
 
-This subproject implements the following features:
+EJML based linear algebra implementation.
 
  - [ejml-vector](src/main/kotlin/space/kscience/kmath/ejml/EjmlVector.kt) : The Point implementation using SimpleMatrix.
  - [ejml-matrix](src/main/kotlin/space/kscience/kmath/ejml/EjmlMatrix.kt) : The Matrix implementation using SimpleMatrix.
  - [ejml-linear-space](src/main/kotlin/space/kscience/kmath/ejml/EjmlLinearSpace.kt) : The LinearSpace implementation using SimpleMatrix.
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-ejml:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-ejml:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-ejml/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-ejml/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-ejml/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-ejml/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-ejml:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-ejml:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-ejml:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-ejml:0.3.0-dev-3")
-> }
-> ```

kmath-ejml/docs/README-TEMPLATE.md

@@ -1,6 +1,6 @@
-# ejml-simple support (`kmath-ejml`)
+# Module kmath-ejml
 
-This subproject implements the following features:
+EJML based linear algebra implementation.
 
 ${features}
 

kmath-for-real/README.md

@@ -1,41 +1,37 @@
-# Real number specialization module (`kmath-for-real`)
+# Module kmath-for-real
+
+Specialization of KMath APIs for Double numbers.
 
  - [DoubleVector](src/commonMain/kotlin/space/kscience/kmath/real/DoubleVector.kt) : Numpy-like operations for Buffers/Points
  - [DoubleMatrix](src/commonMain/kotlin/space/kscience/kmath/real/DoubleMatrix.kt) : Numpy-like operations for 2d real structures
  - [grids](src/commonMain/kotlin/space/kscience/kmath/structures/grids.kt) : Uniform grid generators
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-for-real:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-for-real:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-for-real/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-for-real/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-for-real/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-for-real/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-for-real:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-for-real:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-for-real:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-for-real:0.3.0-dev-3")
-> }
-> ```

kmath-for-real/docs/README-TEMPLATE.md

@@ -1,4 +1,6 @@
-# Real number specialization module (`kmath-for-real`)
+# Module kmath-for-real
+
+Specialization of KMath APIs for Double numbers.
 
 ${features}
 

kmath-functions/README.md

@@ -1,6 +1,6 @@
-# Functions (`kmath-functions`)
+# Module kmath-functions
 
-Functions and interpolations:
+Functions and interpolations.
 
  - [piecewise](Piecewise functions.) : src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt
  - [polynomials](Polynomial functions.) : src/commonMain/kotlin/space/kscience/kmath/functions/Polynomial.kt
@@ -8,37 +8,31 @@ Functions and interpolations:
  - [spline interpolation](Cubic spline XY interpolator.) : src/commonMain/kotlin/space/kscience/kmath/interpolation/SplineInterpolator.kt
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-functions:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-functions:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-functions/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-functions/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-functions/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-functions/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-functions:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-functions:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-functions:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-functions:0.3.0-dev-3")
-> }
-> ```

kmath-functions/docs/README-TEMPLATE.md

@@ -1,6 +1,6 @@
-# Functions (`kmath-functions`)
+# Module kmath-functions
 
-Functions and interpolations:
+Functions and interpolations.
 
 ${features}
 

kmath-nd4j/README.md

@@ -1,46 +1,40 @@
-# ND4J NDStructure implementation (`kmath-nd4j`)
+# Module kmath-nd4j
 
-This subproject implements the following features:
+ND4J based implementations of KMath abstractions.
 
  - [nd4jarraystructure](#) : NDStructure wrapper for INDArray
  - [nd4jarrayrings](#) : Rings over Nd4jArrayStructure of Int and Long
  - [nd4jarrayfields](#) : Fields over Nd4jArrayStructure of Float and Double
 
 
-> #### Artifact:
+## Artifact:
->
+
-> This module artifact: `space.kscience:kmath-nd4j:0.3.0-dev-3`.
+The Maven coordinates of this project are `space.kscience:kmath-nd4j:0.3.0-dev-3`.
->
+
-> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-nd4j/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-nd4j/_latestVersion)
+**Gradle:**
->
+```gradle
-> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-nd4j/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-nd4j/_latestVersion)
+repositories {
->
+    maven { url 'https://repo.kotlin.link' }
-> **Gradle:**
+    maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
->
+    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
-> ```gradle
+}
-> repositories {
+
->     maven { url 'https://repo.kotlin.link' }
+dependencies {
->     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+    implementation 'space.kscience:kmath-nd4j:0.3.0-dev-3'
->     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
+}
-> }
+```
-> 
+**Gradle Kotlin DSL:**
-> dependencies {
+```kotlin
->     implementation 'space.kscience:kmath-nd4j:0.3.0-dev-3'
+repositories {
-> }
+    maven("https://repo.kotlin.link")
-> ```
+    maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
-> **Gradle Kotlin DSL:**
+    maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
->
+}
-> ```kotlin
+
-> repositories {
+dependencies {
->     maven("https://repo.kotlin.link")
+    implementation("space.kscience:kmath-nd4j:0.3.0-dev-3")
->     maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
+}
->     maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
+```
-> }
-> 
-> dependencies {
->     implementation("space.kscience:kmath-nd4j:0.3.0-dev-3")
-> }
-> ```
 
 ## Examples
 

kmath-nd4j/docs/README-TEMPLATE.md

@@ -1,6 +1,6 @@
-# ND4J NDStructure implementation (`kmath-nd4j`)
+# Module kmath-nd4j
 
-This subproject implements the following features:
+ND4J based implementations of KMath abstractions.
 
 ${features}