Fix Android docs deployment (#2412)

This commit is contained in:
Bart Louwers
2024-05-22 18:38:23 +02:00
committed by GitHub
parent 04be6ecbd2
commit d3d29cb9d8
5 changed files with 13 additions and 5 deletions

View File

@@ -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: |

View File

@@ -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/

View File

@@ -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).

View File

@@ -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")
}
}
}

View File

@@ -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" }