Add option to build API docs into bdk-jvm website

This commit is contained in:
thunderbiscuit 2022-10-05 10:10:16 -04:00
parent 3a0fe79dd8
commit 20134bb96a
No known key found for this signature in database
GPG Key ID: 88253696EB836462
3 changed files with 17 additions and 4 deletions

View File

@ -1,6 +1,4 @@
# Module bdk-android # Module bdk-android
The [bitcoindevkit](https://bitcoindevkit.org/) language bindings libraries for Android and the JVM. The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Android.
These docs are valid for both `bdk-jvm` and `bdk-android` libraries.
# Package org.bitcoindevkit # Package org.bitcoindevkit

4
api-docs/Module2.md Normal file
View File

@ -0,0 +1,4 @@
# Module bdk-jvm
The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Kotlin and Java on the JVM.
# Package org.bitcoindevkit

View File

@ -28,8 +28,19 @@ tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
named("main") { named("main") {
moduleName.set("bdk-android") moduleName.set("bdk-android")
moduleVersion.set("0.9.0") moduleVersion.set("0.9.0")
includes.from("Module.md") includes.from("Module1.md")
samples.from("src/test/kotlin/org/bitcoindevkit/Samples.kt") samples.from("src/test/kotlin/org/bitcoindevkit/Samples.kt")
} }
} }
} }
// tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
// dokkaSourceSets {
// named("main") {
// moduleName.set("bdk-jvm")
// moduleVersion.set("0.9.0")
// includes.from("Module2.md")
// samples.from("src/test/kotlin/org/bitcoindevkit/Samples.kt")
// }
// }
// }