Add dokka to generate api reference docs (#1)

Author: mrmans0n

.github/workflows/docs.yaml

@@ -26,6 +26,17 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - uses: gradle/actions/setup-gradle@v4
+
+      - name: Generate API docs
+        run: ./gradlew :dokkaGenerate
+
       - name: Setup uv
         uses: astral-sh/setup-uv@v5
 

.github/workflows/preview-docs.yaml

@@ -7,6 +7,7 @@ on:
       - 'docs/**'
       - 'mkdocs.yml'
       - 'pyproject.toml'
+      - '**/src/**/*.kt'
 
 concurrency:
   group: gh-pages-deploy
@@ -25,6 +26,20 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Setup JDK
+        if: github.event.action != 'closed'
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - uses: gradle/actions/setup-gradle@v4
+        if: github.event.action != 'closed'
+
+      - name: Generate API docs
+        if: github.event.action != 'closed'
+        run: ./gradlew :dokkaGenerate
+
       - name: Setup uv
         if: github.event.action != 'closed'
         uses: astral-sh/setup-uv@v5

.gitignore

@@ -65,3 +65,9 @@ replay_pid*
 
 # Throwaway
 .throwaway/
+
+# Generated API docs
+docs/api/
+
+# MkDocs build
+site/

asyncresult-either/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.multiplatform)
   alias(libs.plugins.android.library)
   alias(libs.plugins.mavenPublish)
+  alias(libs.plugins.dokka)
 }
 
 kotlin {

asyncresult-test/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.multiplatform)
   alias(libs.plugins.android.library)
   alias(libs.plugins.mavenPublish)
+  alias(libs.plugins.dokka)
 }
 
 kotlin {

asyncresult/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
   alias(libs.plugins.kotlin.multiplatform)
   alias(libs.plugins.android.library)
   alias(libs.plugins.mavenPublish)
+  alias(libs.plugins.dokka)
 }
 
 kotlin {

build.gradle.kts

@@ -11,6 +11,18 @@ plugins {
   alias(libs.plugins.android.library) apply false
   alias(libs.plugins.mavenPublish) apply false
   alias(libs.plugins.spotless) apply false
+  alias(libs.plugins.dokka)
+}
+
+dokka {
+  moduleName = "AsyncResult"
+  dokkaPublications.html { outputDirectory = layout.projectDirectory.dir("docs/api") }
+}
+
+dependencies {
+  dokka(projects.asyncresult)
+  dokka(projects.asyncresultEither)
+  dokka(projects.asyncresultTest)
 }
 
 allprojects {

gradle.properties

@@ -4,6 +4,9 @@ org.gradle.parallel=true
 org.gradle.configuration-cache.parallel=true
 org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=512m
 kotlin.daemon.jvmargs=-Xmx2g
+
+# Dokka V2 plugin mode
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 # Required to publish to Nexus (see https://github.com/gradle/gradle/issues/11308)
 systemProp.org.gradle.internal.publish.checksums.insecure=true
 # Increase timeout when pushing to Sonatype

gradle/libs.versions.toml

@@ -5,6 +5,7 @@ assertk = "0.28.1"
 arrow = "2.0.0"
 android-gradle = "8.13.2"
 ktfmt = "0.53"
+dokka = "2.0.0"
 
 [libraries]
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
@@ -18,3 +19,4 @@ kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 android-library = { id = "com.android.library", version.ref = "android-gradle" }
 mavenPublish = "com.vanniktech.maven.publish:0.36.0"
 spotless = { id = "com.diffplug.spotless", version = "8.1.0" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }

mkdocs.yml

@@ -26,6 +26,7 @@ nav:
     - 'Core API': core.md
     - 'Arrow Either': either.md
     - 'Testing': testing.md
+    - 'API Reference': api/index.html
 
 # Configuration
 theme: