Publish docs (#8)

README.md

@@ -1,6 +1,8 @@
 # Certora Collections
 
-Memory-efficient immutable collections for Kotlin.
+[![](https://jitpack.io/v/certora/collections.svg)](https://jitpack.io/#certora/collections)
+
+Fast, memory-efficient immutable collections for Kotlin.
 
 ## Motivation
 
@@ -19,3 +21,18 @@ structure, such computing set unions or intersection of two sets, or merging two
 The Certora Collections library provides `Set` and `Map` implementations which are optimized primarily for such
 operations.  Further, we optimize heavily for memory usage over speed of operations on single elements.  We also provide
 some additional features that we have found useful in the Certora Prover, such as efficient parallel operations.
+
+## Usage
+
+[![](https://jitpack.io/v/certora/collections.svg)](https://jitpack.io/#certora/collections)<br/>
+The Certora Collections library is available on [JitPack](https://jitpack.io/#certora/collections).
+
+### API
+
+The API builds on the interfaces provided by [kotlinx.collections.immutable].  See The Kotlin Immutable Collections
+[proposal](https://github.com/Kotlin/kotlinx.collections.immutable/blob/master/proposal.md).  We provide some additional
+interfaces above the `PersistentMap` and `PersistentSet` interfaces provided by `kotlinx.collections.immutable`:
+
+-
+
+

build.gradle.kts

@@ -38,12 +38,4 @@ subprojects {
 			freeCompilerArgs += "-Xcontext-receivers"
 		}
 	}
-
-    publishing {
-        publications {
-            create<MavenPublication>("maven") {
-                from(components["java"])
-            }
-        }
-    }
 }

collect/build.gradle.kts

@@ -1,10 +1,21 @@
 import org.gradle.api.tasks.*
 import org.gradle.kotlin.dsl.*
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.base.DokkaBaseConfiguration
+import java.net.URL
 
 plugins {
 	kotlin("jvm")
 	id("io.github.detekt.gradle.compiler-plugin")
     id("java-library")
+    id("org.jetbrains.dokka")
+}
+
+buildscript {
+    dependencies {
+        classpath("org.jetbrains.dokka:dokka-base:1.9.10")
+    }
 }
 
 kotlin {
@@ -22,3 +33,40 @@ dependencies {
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit")
 	testImplementation("org.jetbrains.kotlinx:kotlinx-serialization-json:${property("serializationVersion")}")
 }
+
+tasks.withType<DokkaTask>().configureEach {
+    moduleName.set("Certora Collections")
+    //failOnWarning.set(true)
+    suppressObviousFunctions.set(true)
+    suppressInheritedMembers.set(false)
+
+    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
+        customAssets = listOf(file("../assets/logo-icon.svg"))
+        footerMessage = "(c) Certora"
+    }
+
+    dokkaSourceSets.configureEach {
+        reportUndocumented.set(true)
+
+        sourceLink {
+            localDirectory.set(projectDir.resolve("src"))
+            remoteUrl.set(URL("https://github.com/Certora/collections/tree/main/collect/src"))
+            remoteLineSuffix.set("#L")
+        }
+    }
+}
+
+tasks.register<Jar>("dokkaJar") {
+    dependsOn(tasks.dokkaHtml)
+    from(tasks.dokkaHtml.flatMap { it.outputDirectory })
+    archiveClassifier.set("javadoc")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            from(components["java"])
+            artifact(tasks["dokkaJar"])
+        }
+    }
+}

detekt-treapability/build.gradle.kts

@@ -22,3 +22,11 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-params:$junitVersion")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
 }
+
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            from(components["java"])
+        }
+    }
+}

gradle.properties

@@ -4,6 +4,6 @@ detektVersion=1.23.1
 junitVersion=5.9.1
 axionVersion=1.15.5
 benchmarkVersion=0.4.4
+dokkaVersion=1.9.10
 immutableCollectionsVersion=0.3.5
 serializationVersion=1.5.0
-

settings.gradle.kts

@@ -3,13 +3,15 @@ pluginManagement {
     val detektVersion: String by settings
     val axionVersion: String by settings
     val benchmarkVersion: String by settings
+    val dokkaVersion: String by settings
     plugins {
         id("org.jetbrains.kotlin.jvm") version kotlinVersion
         id("org.jetbrains.kotlin.plugin.serialization") version kotlinVersion
         id("org.jetbrains.kotlin.plugin.allopen") version kotlinVersion
         id("io.github.detekt.gradle.compiler-plugin") version detektVersion
         id("pl.allegro.tech.build.axion-release") version axionVersion
         id("org.jetbrains.kotlinx.benchmark") version benchmarkVersion
+        id("org.jetbrains.dokka") version dokkaVersion
     }
     repositories {
         mavenCentral()