Add Module.md infos to kotlin modules for dokka (#238)

* Module docs WIP * Finish fleshing out modules
uber · Aug 3, 2018 · f541f4b · f541f4b
1 parent 7457d68
commit f541f4b
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 0 deletions.
diff --git a/android/autodispose-android-archcomponents-ktx/Module.md b/android/autodispose-android-archcomponents-ktx/Module.md
@@ -0,0 +1,7 @@
+# Module autodispose-android-ktx
+
+Kotlin extensions for `autodispose-android-archcomponents`.
+
+# Package com.uber.autodispose.android.lifecycle
+
+Kotlin extensions for `autodispose-android-archcomponents`.
diff --git a/android/autodispose-android-archcomponents-test-ktx/Module.md b/android/autodispose-android-archcomponents-test-ktx/Module.md
@@ -0,0 +1,7 @@
+# Module autodispose-android-ktx
+
+Kotlin extensions for `autodispose-android-archcomponents-test`.
+
+# Package com.uber.autodispose.android.lifecycle.test
+
+Kotlin extensions for `autodispose-android-archcomponents-test`.
diff --git a/android/autodispose-android-ktx/Module.md b/android/autodispose-android-ktx/Module.md
@@ -0,0 +1,7 @@
+# Module autodispose-android-ktx
+
+Kotlin extensions for `autodispose-android`.
+
+# Package com.uber.autodispose.android
+
+Kotlin extensions for `autodispose-android`.
diff --git a/autodispose-ktx/Module.md b/autodispose-ktx/Module.md
@@ -0,0 +1,7 @@
+# Module autodispose-ktx
+
+Kotlin extensions for `autodispose`.
+
+# Package com.uber.autodispose
+
+Kotlin extensions for `autodispose`.
diff --git a/gradle/gradle-mvn-push.gradle b/gradle/gradle-mvn-push.gradle
@@ -54,6 +54,7 @@ def kotlinAndroidArtifactTasks() {
 
     outputFormat = 'html'
     outputDirectory = "$buildDir/docs/kdoc"
+    includes = ['Module.md']
     classpath = new ArrayList<File>(project.tasks['assemble'].outputs.files.files)
     sourceDirs = android.sourceSets.main.java.srcDirs
   }
@@ -81,6 +82,7 @@ def kotlinArtifactTasks() {
 
     outputFormat = 'html'
     outputDirectory = "$buildDir/docs/kdoc"
+    includes = ['Module.md']
     sourceDirs = sourceSets.main.allSource
   }
 

diff --git a/lifecycle/autodispose-lifecycle-ktx/Module.md b/lifecycle/autodispose-lifecycle-ktx/Module.md
@@ -0,0 +1,7 @@
+# Module autodispose-lifecycle-ktx
+
+Kotlin extensions for `autodispose-lifecycle`.
+
+# Package com.uber.autodispose.lifecycle
+
+Kotlin extensions for `autodispose-lifecycle`.