docs: updated dokka (#801)

Author: kikoso

.github/workflows/docs.yml

@@ -43,10 +43,10 @@ jobs:
     # Run dokka and create tar
     - name: Generate documentation
       run: |
-        ./gradlew dokkaHtmlMultiModule
+        ./gradlew docs:dokkaGenerate
 
         echo "Creating tar for generated docs"
-        cd $GITHUB_WORKSPACE/build/dokka/htmlMultiModule && tar cvf ~/maps-compose-docs.tar .
+        cd $GITHUB_WORKSPACE/docs/build/dokka/html && tar cvf ~/maps-compose-docs.tar .
 
         echo "Unpacking tar into gh-pages branch"
         git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*

.gitignore

@@ -11,6 +11,7 @@
 /.idea/assetWizardSettings.xml
 .DS_Store
 /build
+build/
 /captures
 .externalNativeBuild
 .cxx

build-logic/convention/src/main/kotlin/dokka-convention.gradle.kts

@@ -0,0 +1,15 @@
+/**
+ * Common conventions for generating documentation with Dokka.
+ */
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+dokka {
+    dokkaSourceSets.configureEach {
+        sourceLink {
+            localDirectory.set(rootDir)
+        }
+    }
+}

build.gradle.kts

@@ -14,7 +14,7 @@ buildscript {
 }
 
 plugins {
-    alias(libs.plugins.dokka) apply true
+    id("org.jetbrains.dokka") version "2.1.0"
     alias(libs.plugins.compose.compiler) apply false
     id("com.autonomousapps.dependency-analysis") version "3.4.1"
     alias(libs.plugins.android.application) apply false

docs/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+    kotlin("jvm") apply false
+    id("org.jetbrains.dokka")
+}
+
+dependencies {
+    dokka(project(":maps-compose"))
+    dokka(project(":maps-compose-utils"))
+    dokka(project(":maps-compose-widgets"))
+}
+
+dokka {
+    moduleName.set("Android Maps Compose")
+}

maps-compose-utils/build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
     id("kotlin-android")
     alias(libs.plugins.compose.compiler)
     id("android.maps.compose.PublishingConventionPlugin")
+    id("org.jetbrains.dokka")
 }
 
 android {

maps-compose-widgets/build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
     id("kotlin-android")
     alias (libs.plugins.compose.compiler)
     id("android.maps.compose.PublishingConventionPlugin")
+    id("org.jetbrains.dokka")
 }
 
 android {

maps-compose/build.gradle.kts

@@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 plugins {
     id("org.jetbrains.kotlin.android")
     alias(libs.plugins.compose.compiler)
+    id("org.jetbrains.dokka")
     id("android.maps.compose.PublishingConventionPlugin")
 }
 
@@ -98,3 +99,9 @@ val generateArtifactIdFile = tasks.register("generateArtifactIdFile") {
 tasks.named("preBuild") {
     dependsOn(generateArtifactIdFile)
 }
+
+dokka {
+    dokkaSourceSets.configureEach {
+
+    }
+}

settings.gradle.kts

@@ -18,4 +18,5 @@ rootProject.name = "android-maps-compose"
 include(":maps-app")
 include(":maps-compose")
 include(":maps-compose-widgets")
-include(":maps-compose-utils")
+include(":maps-compose-utils")
+include(":docs")