Skip to content

fix(dokka): proper multi-module Dokka using root-level aggregation #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wax911 merged 1 commit into from
Jun 19, 2026
Merged

fix(dokka): proper multi-module Dokka using root-level aggregation #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 5 additions & 52 deletions .github/workflows/gradle-dokka.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ env:

jobs:
gradle-dokka:
name: Generate Dokka Documentation
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
Expand All @@ -23,60 +26,10 @@ jobs:
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Generate docs with dokka
run: |
./gradlew :annotations:dokkaGeneratePublicationHtml \
:api:dokkaGeneratePublicationHtml \
:android-assets:dokkaGeneratePublicationHtml \
:runtime:dokkaGeneratePublicationHtml \
:codegen-core:dokkaGeneratePublicationHtml \
:serialization-gson:dokkaGeneratePublicationHtml \
:serialization-kotlinx:dokkaGeneratePublicationHtml \
:library:dokkaGeneratePublicationHtml
# Merge all module docs into combined-docs with subdirectories
mkdir -p combined-docs
for module in annotations api android-assets runtime codegen-core serialization-gson serialization-kotlinx library; do
if [ -d "$module/build/dokka/html" ]; then
mkdir -p "combined-docs/$module"
cp -r "$module/build/dokka/html/"* "combined-docs/$module/" 2>/dev/null || true
fi
done
# Generate a root index.html linking to each module's docs
cat > combined-docs/index.html << 'HTML'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>retrofit-graphql API Docs</title>
<style>
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; max-width: 720px; margin: 40px auto; padding: 0 20px; line-height: 1.6; }
h1 { border-bottom: 2px solid #eee; padding-bottom: 12px; }
ul { list-style: none; padding: 0; }
li { margin: 8px 0; }
a { color: #0366d6; text-decoration: none; font-size: 16px; }
a:hover { text-decoration: underline; }
code { background: #f6f8fa; padding: 2px 6px; border-radius: 3px; font-size: 14px; }
</style>
</head>
<body>
<h1>retrofit-graphql API Documentation</h1>
<p>Multi-module Kotlin library for injecting <code>.graphql</code> files into Retrofit HTTP requests.</p>
<ul>
<li><a href="annotations/">annotations</a> <span style="color:#666">&mdash; @GraphQuery annotation</span></li>
<li><a href="api/">api</a> <span style="color:#666">&mdash; Public API interfaces and models</span></li>
<li><a href="android-assets/">android-assets</a> <span style="color:#666">&mdash; Asset-based query discovery</span></li>
<li><a href="runtime/">runtime</a> <span style="color:#666">&mdash; Retrofit Converter.Factory</span></li>
<li><a href="codegen-core/">codegen-core</a> <span style="color:#666">&mdash; Code generation engine</span></li>
<li><a href="serialization-gson/">serialization-gson</a> <span style="color:#666">&mdash; Gson backend</span></li>
<li><a href="serialization-kotlinx/">serialization-kotlinx</a> <span style="color:#666">&mdash; kotlinx.serialization backend</span></li>
<li><a href="library/">library</a> <span style="color:#666">&mdash; Legacy facade (deprecated type aliases)</span></li>
</ul>
</body>
</html>
HTML
run: ./gradlew dokkaGeneratePublicationHtml

- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4.8.0
with:
branch: docs # The branch the action should deploy to.
folder: combined-docs
folder: dokka-docs
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,3 +251,4 @@ app/lint-baseline.xml

# OpenCode deepwork session files
.slim/deepwork/
dokka-docs/
45 changes: 45 additions & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
import org.jetbrains.dokka.gradle.DokkaExtension

plugins {
id("org.jetbrains.dokka")
}

buildscript {
repositories {
google()
Expand All @@ -17,3 +23,42 @@ allprojects {
mavenCentral()
}
}

// Multi-module Dokka: aggregate docs from all subprojects
dependencies {
dokka(project(":annotations"))
dokka(project(":api"))
dokka(project(":android-assets"))
dokka(project(":runtime"))
dokka(project(":codegen-core"))
dokka(project(":serialization-gson"))
dokka(project(":serialization-kotlinx"))
dokka(project(":library"))
}

dokka {
dokkaPublications.html {
outputDirectory.set(rootProject.file("dokka-docs"))
failOnWarning.set(false)
}
}

// Configure source links for subprojects that have Dokka applied
subprojects {
plugins.withId("org.jetbrains.dokka") {
extensions.configure(DokkaExtension::class.java) {
val modulePath = project.path.removePrefix(":").replace(":", "/")

dokkaSourceSets.configureEach {
reportUndocumented.set(true)
skipEmptyPackages.set(true)

sourceLink {
localDirectory.set(layout.projectDirectory.dir("src/main/kotlin"))
remoteUrl.set(java.net.URI("https://github.com/AniTrend/retrofit-graphql/tree/develop/$modulePath/src/main/kotlin"))
remoteLineSuffix.set("#L")
}
}
}
}
}
Loading