basic knit setup

README.md

@@ -4,11 +4,12 @@
 
 ___
 
-Tangle creates [Dagger] bindings for Android classes using the [Anvil] Kotlin compiler plugin.
-This is meant to be an alternative to [Hilt], for those who'd prefer to enjoy the faster compilation
-and better flexibility of Anvil.
+Tangle creates [Dagger] bindings for Android classes using the [Anvil] Kotlin compiler plugin. This
+is meant to be an alternative to [Hilt], for those who'd prefer to enjoy the faster compilation and
+better flexibility of Anvil.
 
-Since Tangle is an extension upon Anvil, its code generation will be applied to **Kotlin** files only.
+Since Tangle is an extension upon Anvil, its code generation will be applied to **Kotlin** files
+only.
 
 ``` Kotlin
 @ContributesViewModel(AppScope::class)
@@ -38,7 +39,6 @@ ____
 
 <!--- END -->
 
-
 ## Config
 
 The `TangleComponents` holder needs to be initialized with an application-scoped Dagger Component in
@@ -127,23 +127,24 @@ dependencies {
 }
 ```
 
-
 ## SavedStateHandle injection
 
-Tangle supports injecting [SavedStateHandle] into ViewModel constructors,
-where the `SavedStateHandle` is provided by the ViewModel's owning `Fragment`/`Activity`/`NavBackStackEntry`.
+Tangle supports injecting [SavedStateHandle] into ViewModel constructors, where
+the `SavedStateHandle` is provided by the ViewModel's owning `Fragment`/`Activity`
+/`NavBackStackEntry`.
 
-In addition to or in lieu of `SavedStateHandle`, Tangle can automatically extract arguments
-from the `SavedStateHandle` and inject them into the constructor,
-through use of the `FromSavedStateHandle` annotation.
+In addition to or in lieu of `SavedStateHandle`, Tangle can automatically extract arguments from
+the `SavedStateHandle` and inject them into the constructor, through use of
+the `FromSavedStateHandle` annotation.
 
-If the constructor argument's type is not nullable, then Tangle will assert that the argument
-is in the bundle while creating the ViewModel.
+If the constructor argument's type is not nullable, then Tangle will assert that the argument is in
+the bundle while creating the ViewModel.
 
-If the argument is marked as nullable,
-then Tangle will gracefully handle a missing argument and just inject `null`.
+If the argument is marked as nullable, then Tangle will gracefully handle a missing argument and
+just inject `null`.
 
 Given this code:
+
 ``` Kotlin
 @ContributesViewModel(AppScope::class)
 class MyViewModel @VMInject constructor(
@@ -153,7 +154,9 @@ class MyViewModel @VMInject constructor(
   val addressOrNull: String?
 ) : ViewModel()
 ```
+
 Tangle will generate this Provider:
+
 ``` Kotlin
 public class MyViewModel_Provider @Inject constructor(
   private val savedStateHandle: Provider<SavedStateHandle>
@@ -170,7 +173,6 @@ public class MyViewModel_Provider @Inject constructor(
 }
 ```
 
-
 ## Compose support
 
 Tangle supports ViewModel "injection" in composables in a manner very similar to Hilt's
@@ -201,7 +203,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 ```
 
-[Anvil]:https://github.com/square/anvil
-[Dagger]:https://dagger.dev
-[Hilt]:https://dagger.dev/hilt/view-model.html
-[SavedStateHandle]:https://developer.android.com/topic/libraries/architecture/viewmodel-savedstate
+
+[Anvil]: https://github.com/square/anvil
+
+[Dagger]: https://dagger.dev
+
+[Hilt]: https://dagger.dev/hilt/view-model.html
+
+[SavedStateHandle]: https://developer.android.com/topic/libraries/architecture/viewmodel-savedstate

build.gradle.kts

@@ -193,3 +193,34 @@ subprojects {
     }
   }
 }
+
+apply(plugin = "kotlinx-knit")
+
+extensions.configure<kotlinx.knit.KnitPluginExtension> {
+
+  rootDir = rootProject.rootDir
+
+  files = fileTree(project.rootDir) {
+    include(
+      "**/*.md",
+      "**/*.kt",
+      "**/*.kts"
+    )
+    exclude(
+      "**/node_modules/**",
+      "**/build/**",
+      "**/.gradle/**"
+    )
+  }
+
+  moduleRoots = listOf(".")
+
+  moduleDocs = "build/dokka"
+  moduleMarkers = listOf("build.gradle", "build.gradle.kts")
+  siteRoot = "https://rbusarow.github.io/Tangle/api"
+}
+
+// Build API docs for all modules with dokka before running Knit
+tasks.withType<kotlinx.knit.KnitTask>().configureEach {
+  dependsOn(tasks.findByName("dokkaHtmlMultiModule"))
+}