Add module documentations

kordlib · Sep 12, 2023 · 73f2262 · 73f2262
1 parent 5acfa3e
commit 73f2262
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/buildSrc/src/main/kotlin/kord-publishing.gradle.kts b/buildSrc/src/main/kotlin/kord-publishing.gradle.kts
@@ -15,7 +15,10 @@ tasks {
             suppressGeneratedFiles = false
             jdkVersion = 8
 
-            includes.from(layout.projectDirectory.file("README.md"))
+            val readme = layout.projectDirectory.file("README.md").asFile
+            if (readme.exists()) {
+                includes.from(readme)
+            }
 
             externalDocumentationLink("https://square.github.io/kotlinpoet/1.x/kotlinpoet/kotlinpoet/")
 

diff --git a/kotlinpoet/README.md b/kotlinpoet/README.md
@@ -1,3 +1,3 @@
-# kotlinpoet
+# Module kotlinpoet
 
 Please refer to the [KotlinPoet module documentation](https://codegen.kord.dev/kotlinpoet.html)
diff --git a/ksp/README.md b/ksp/README.md
@@ -1,3 +1,3 @@
-# ksp
+# Module ksp
 
 Please refer to the [KSP module documentation](https://codegen.kord.dev/ksp.html)