557bc5ef6a## #252 Add module documentation and enhance Dokka configuration ## How Has This Been Tested? `./gradlew :docs:dokkaGenerate` ## Changes - Add workflow to build and publish API documentation with Dokka - Introduce `.github/workflows/apidocs.yaml` to build and deploy API docs on `main` and release events. - Configure Gradle for Dokka builds and update project dependencies. - Include `:docs` module in project settings. - Introduce `Module.md` for `kotlin-sdk-server`, `kotlin-sdk-client`, and `kotlin-sdk-core` modules. - Update `.gitignore` to include `.idea/icon.png` and add placeholder icon files - Remove outdated documentation HTML files ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [x] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> --------- Co-authored-by: devcrocod <devcrocod@gmail.com>
51 lines
1,008 B
Kotlin
51 lines
1,008 B
Kotlin
plugins {
|
|
id("mcp.dokka")
|
|
alias(libs.plugins.ktlint)
|
|
alias(libs.plugins.kover)
|
|
}
|
|
|
|
allprojects {
|
|
group = "io.modelcontextprotocol"
|
|
version = "0.7.0"
|
|
}
|
|
|
|
dependencies {
|
|
dokka(project(":kotlin-sdk-core"))
|
|
dokka(project(":kotlin-sdk-client"))
|
|
dokka(project(":kotlin-sdk-server"))
|
|
|
|
kover(project(":kotlin-sdk-core"))
|
|
kover(project(":kotlin-sdk-client"))
|
|
kover(project(":kotlin-sdk-server"))
|
|
kover(project(":kotlin-sdk-test"))
|
|
}
|
|
|
|
subprojects {
|
|
apply(plugin = "org.jlleitschuh.gradle.ktlint")
|
|
apply(plugin = "org.jetbrains.kotlinx.kover")
|
|
}
|
|
|
|
dokka {
|
|
moduleName = "MCP Kotlin SDK"
|
|
|
|
dokkaPublications.html {
|
|
includes.from("docs/moduledoc.md")
|
|
}
|
|
}
|
|
|
|
kover {
|
|
reports {
|
|
filters {
|
|
includes.classes("io.modelcontextprotocol.kotlin.sdk.*")
|
|
}
|
|
total {
|
|
log {
|
|
}
|
|
verify {
|
|
rule {
|
|
minBound(65)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|