Fix Android docs deployment (maplibre#2412)

mwilsnd · May 22, 2024 · d3d29cb · d3d29cb
1 parent 04be6ec
commit d3d29cb
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/.github/workflows/android-ci.yml b/.github/workflows/android-ci.yml
@@ -109,6 +109,9 @@ jobs:
       - name: Build libmaplibre.so for arm-v8
         run: make android-lib-arm-v8
 
+      - name: Build documentation
+        run: ./gradlew dokkaHtml
+
       - name: Copy developer config with API key for UI tests
         if: github.ref == 'refs/heads/main'
         run: |

diff --git a/.github/workflows/gh-pages-android-api.yml b/.github/workflows/gh-pages-android-api.yml
@@ -13,6 +13,11 @@ jobs:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
 
+      - uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
       - name: Generate documentation
         run: ./gradlew dokkaHtml
 
@@ -22,3 +27,4 @@ jobs:
           branch: gh-pages
           folder: platform/android/MapLibreAndroid/build/dokka/html
           target-folder: android/api/
+
diff --git a/platform/android/MapLibreAndroid/README.md → platform/android/MapLibreAndroid/Module.md b/platform/android/MapLibreAndroid/README.md → platform/android/MapLibreAndroid/Module.md
@@ -1,4 +1,4 @@
-# MapLibre Native for Android
+# Module MapLibre Native Android
 
 This is the API documentation for the Android API of [MapLibre Native](https://github.com/maplibre/maplibre-native).
 

diff --git a/platform/android/MapLibreAndroid/build.gradle b/platform/android/MapLibreAndroid/build.gradle
@@ -34,12 +34,11 @@ dependencies {
 }
 
 tasks.withType(DokkaTask.class) {
-    moduleName.set("MapLibre Native for Android")
+    moduleName.set("MapLibre Native Android")
 
     dokkaSourceSets {
-
         configureEach {
-            includes.from("README.md")
+            includes.from("Module.md")
         }
     } 
 }

diff --git a/platform/android/gradle/libs.versions.toml b/platform/android/gradle/libs.versions.toml
@@ -88,5 +88,5 @@ androidGradlePlugin = { group = "com.android.tools.build", name = "gradle", vers
 nexusPublishPlugin = { id = "io.github.gradle-nexus.publish-plugin", version = "1.1.0" }
 kotlinter = { id = "org.jmailen.kotlinter", version = "3.13.0" }
 kotlinAndroid = { id = "org.jetbrains.kotlin.android", version = "1.9.21" }
-dokka = { id = "org.jetbrains.dokka", version = "1.7.20" }
+dokka = { id = "org.jetbrains.dokka", version = "1.9.20" }
 kotlinPluginSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version = "1.9.21" }