diff --git a/bdk-android/build.gradle.kts b/bdk-android/build.gradle.kts index 0b913538..428dcf2b 100644 --- a/bdk-android/build.gradle.kts +++ b/bdk-android/build.gradle.kts @@ -4,7 +4,8 @@ plugins { id("org.gradle.maven-publish") id("org.gradle.signing") id("io.github.gradle-nexus.publish-plugin").version("1.1.0").apply(true) - id("org.jetbrains.dokka").version("1.9.0").apply(false) + id("org.jetbrains.dokka").version("2.0.0").apply(false) + id("org.jetbrains.dokka-javadoc").version("2.0.0").apply(false) } // library version is defined in gradle.properties diff --git a/bdk-android/gradle.properties b/bdk-android/gradle.properties index 93885a0e..826af13d 100644 --- a/bdk-android/gradle.properties +++ b/bdk-android/gradle.properties @@ -2,4 +2,5 @@ org.gradle.jvmargs=-Xmx1536m android.useAndroidX=true android.enableJetifier=true kotlin.code.style=official -libraryVersion=1.0.0-beta.7-SNAPSHOT +libraryVersion=1.0.0-beta.7 +org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled \ No newline at end of file diff --git a/bdk-android/justfile b/bdk-android/justfile index e83c25e2..d66853f2 100644 --- a/bdk-android/justfile +++ b/bdk-android/justfile @@ -24,3 +24,6 @@ test: test-specific TEST: ./gradlew test --tests {{TEST}} + +build-docs: + ./gradlew :lib:dokkaGeneratePublicationHtml diff --git a/bdk-android/lib/README.md b/bdk-android/lib/README.md new file mode 100644 index 00000000..011e168d --- /dev/null +++ b/bdk-android/lib/README.md @@ -0,0 +1,11 @@ +# Module bdk-android + +The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Kotlin on the JVM. + +# Package org.bitcoindevkit + +The types coming from BDK directly. The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), and [bdk_esplora](https://crates.io/crates/bdk_esplora) crates. + +# Package org.rustbitcoin.bitcoin + +The types exposed from the [rust-bitcoin](https://crates.io/crates/bitcoin) library. diff --git a/bdk-android/lib/build.gradle.kts b/bdk-android/lib/build.gradle.kts index c1b64995..1f5b7866 100644 --- a/bdk-android/lib/build.gradle.kts +++ b/bdk-android/lib/build.gradle.kts @@ -9,6 +9,7 @@ plugins { id("org.gradle.maven-publish") id("org.gradle.signing") id("org.jetbrains.dokka") + id("org.jetbrains.dokka-javadoc") } android { @@ -116,3 +117,21 @@ signing { useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword) sign(publishing.publications) } + +dokka { + moduleName.set("bdk-android") + moduleVersion.set(libraryVersion) + dokkaSourceSets.main { + includes.from("README.md") + sourceLink { + localDirectory.set(file("src/main/kotlin")) + remoteUrl("https://bitcoindevkit.org/") + remoteLineSuffix.set("#L") + } + } + pluginsConfiguration.html { + // customStyleSheets.from("styles.css") + // customAssets.from("logo.svg") + footerMessage.set("(c) Bitcoin Dev Kit Developers") + } +} diff --git a/bdk-jvm/build.gradle.kts b/bdk-jvm/build.gradle.kts index c8c6e75d..91d34820 100644 --- a/bdk-jvm/build.gradle.kts +++ b/bdk-jvm/build.gradle.kts @@ -4,7 +4,8 @@ plugins { id("org.gradle.maven-publish") id("org.gradle.signing") id("io.github.gradle-nexus.publish-plugin") version "1.1.0" - id("org.jetbrains.dokka").version("1.9.0").apply(false) + id("org.jetbrains.dokka").version("2.0.0").apply(false) + id("org.jetbrains.dokka-javadoc").version("2.0.0").apply(false) } // library version is defined in gradle.properties diff --git a/bdk-jvm/gradle.properties b/bdk-jvm/gradle.properties index 431f3df0..e5d82a85 100644 --- a/bdk-jvm/gradle.properties +++ b/bdk-jvm/gradle.properties @@ -1,4 +1,5 @@ org.gradle.jvmargs=-Xmx1536m android.enableJetifier=true kotlin.code.style=official -libraryVersion=1.0.0-beta.7-SNAPSHOT +libraryVersion=1.0.0-beta.7 +org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled \ No newline at end of file diff --git a/bdk-jvm/justfile b/bdk-jvm/justfile index 7228ecb8..395b7b27 100644 --- a/bdk-jvm/justfile +++ b/bdk-jvm/justfile @@ -29,3 +29,6 @@ test-offline: test-specific TEST: ./gradlew test --tests {{TEST}} + +build-docs: + ./gradlew :lib:dokkaGeneratePublicationHtml diff --git a/bdk-jvm/lib/README.md b/bdk-jvm/lib/README.md new file mode 100644 index 00000000..7872c38f --- /dev/null +++ b/bdk-jvm/lib/README.md @@ -0,0 +1,11 @@ +# Module bdk-jvm + +The [bitcoindevkit](https://bitcoindevkit.org/) language bindings library for Kotlin on the JVM. + +# Package org.bitcoindevkit + +The types coming from BDK directly. The functionality exposed in this package is in fact a combination of the [bdk_wallet](https://crates.io/crates/bdk_wallet), [bdk_core](https://crates.io/crates/bdk_core), [bdk_electrum](https://crates.io/crates/bdk_electrum), and [bdk_esplora](https://crates.io/crates/bdk_esplora) crates. + +# Package org.rustbitcoin.bitcoin + +The types exposed from the [rust-bitcoin](https://crates.io/crates/bitcoin) library. diff --git a/bdk-jvm/lib/build.gradle.kts b/bdk-jvm/lib/build.gradle.kts index 5731cd79..c1860daa 100644 --- a/bdk-jvm/lib/build.gradle.kts +++ b/bdk-jvm/lib/build.gradle.kts @@ -11,6 +11,7 @@ plugins { id("org.gradle.maven-publish") id("org.gradle.signing") id("org.jetbrains.dokka") + id("org.jetbrains.dokka-javadoc") } java { @@ -124,3 +125,21 @@ signing { useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword) sign(publishing.publications) } + +dokka { + moduleName.set("bdk-jvm") + moduleVersion.set(libraryVersion) + dokkaSourceSets.main { + includes.from("README.md") + sourceLink { + localDirectory.set(file("src/main/kotlin")) + remoteUrl("https://bitcoindevkit.org/") + remoteLineSuffix.set("#L") + } + } + pluginsConfiguration.html { + // customStyleSheets.from("styles.css") + // customAssets.from("logo.svg") + footerMessage.set("(c) Bitcoin Dev Kit Developers") + } +} diff --git a/bdk-python/setup.py b/bdk-python/setup.py index 778474fb..b9d21a71 100644 --- a/bdk-python/setup.py +++ b/bdk-python/setup.py @@ -18,7 +18,7 @@ setup( name="bdkpython", - version="1.0.0b7.dev", + version="1.0.0b7", description="The Python language bindings for the Bitcoin Development Kit", long_description=LONG_DESCRIPTION, long_description_content_type="text/markdown",