Add API docs to the generate page

.github/workflows/publish-snapshot.yml

@@ -33,6 +33,9 @@ jobs:
           ORG_GRADLE_PROJECT_SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
         run: ./gradlew uploadArchives --no-daemon --no-parallel --stacktrace
 
+      - name: Build HTML Docs
+        run: ./gradlew dokkaHtml --stacktrace
+
       - name: Stop Gradle
         run: ./gradlew --stop
 

.gitignore

@@ -15,3 +15,6 @@ build/
 
 # OSX
 .DS_Store
+
+# MkDocs
+/docs/api

README.md

@@ -66,7 +66,7 @@ fun main(context: Context) {
   // Prints "109yd 1ft 1in".
   val humanReadableDistance: String = distance.format(context)
 
-  // Prints "109yd 1ft 1in".
+  // Prints "100.00m".
   val humanReadableLength: String = length.format(context)
 }
 ```

build.gradle

@@ -14,7 +14,7 @@ buildscript {
     classpath libs.android.gradlePlugin
     classpath libs.kotlinGradlePlugin
     classpath libs.mavenPublishGradlePlugin
-    classpath libs.dokkaGradlePlugin
+    classpath libs.dokka.gradlePlugin
     classpath libs.detekt.gradlePlugin
     classpath libs.gradleVersions.gradlePlugin
   }

docs/index.md

@@ -33,7 +33,7 @@ fun main(context: Context) {
   // Prints "109yd 1ft 1in".
   val humanReadableDistance: String = distance.format(context)
 
-  // Prints "109yd 1ft 1in".
+  // Prints "100.00m".
   val humanReadableLength: String = length.format(context)
 }
 ```

gradle.properties

@@ -16,7 +16,8 @@ POM_DEVELOPER_ID=michalsikora90
 POM_DEVELOPER_NAME=Michal Sikora
 
 # Increase the build VMs heap size. Default is 512m.
-org.gradle.jvmargs=-Xmx2g
+# Increase metaspace for Dokka https://github.com/Kotlin/dokka/issues/1405
+org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=1g
 org.gradle.parallel=true
 
 android.useAndroidX=true

gradle/dependencies.gradle

@@ -14,7 +14,10 @@ ext.libs = [
         "xTestCoreKtx": "androidx.test:core-ktx:1.3.0"
     ],
     "kotlinGradlePlugin": "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4.21",
-    "dokkaGradlePlugin": "org.jetbrains.dokka:dokka-gradle-plugin:1.4.20",
+    "dokka": [
+        "gradlePlugin": "org.jetbrains.dokka:dokka-gradle-plugin:1.4.20",
+        "gradlePluginId": "org.jetbrains.dokka",
+    ],
     "kotest": [
         "runnerJunit5": "io.kotest:kotest-runner-junit5-jvm:${versions.kotest}",
         "assertions": "io.kotest:kotest-assertions-core-jvm:${versions.kotest}",

gradle/dokka-config.gradle

@@ -0,0 +1,14 @@
+apply plugin: libs.dokka.gradlePluginId
+
+dokkaHtml {
+  outputDirectory.set(file("$rootDir/docs/api/${project.name}"))
+
+  dokkaSourceSets {
+    configureEach {
+      jdkVersion.set(8)
+      reportUndocumented.set(false)
+      skipDeprecated.set(true)
+      skipEmptyPackages.set(true)
+    }
+  }
+}

library/android/build.gradle

@@ -21,4 +21,5 @@ dependencies {
   testImplementation libs.junit
 }
 
+apply from: "$rootDir/gradle/dokka-config.gradle"
 apply from: "$rootDir/gradle/gradle-mvn-push.gradle"

library/ruler/build.gradle

@@ -10,4 +10,5 @@ dependencies {
   testImplementation libs.kotest.property
 }
 
+apply from: "$rootDir/gradle/dokka-config.gradle"
 apply from: "$rootDir/gradle/gradle-mvn-push.gradle"

mkdocs.yml

@@ -38,6 +38,8 @@ plugins:
 nav:
   - 'Quick start': index.md
   - 'User guide': user-guide.md
-  - 'API': api.md
+  - 'API':
+      - 'ruler': api/ruler/ruler/index.html
+      - 'ruler-android': api/android/android/index.html
   - 'Changelog': changelog.md
   - 'Releasing': releasing.md