Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ jobs:
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Set up JDK 17
- name: Set up JDK 21
uses: actions/setup-java@v2
with:
distribution: adopt
java-version: 17
java-version: 21
- name: Make gradlew executable
run: chmod +x ./gradlew
- name: Generate Dokka HTML docs
run: ./gradlew dokkaHtmlMultiModule
run: ./gradlew dokkaGenerate
- name: Deploy to GitHub pages
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.PERSONAL_TOKEN }}
external_repository: SceneView/sceneview.github.io
publish_branch: main
publish_dir: ./build/dokka/htmlMultiModule
publish_dir: ./build/dokka/html
destination_dir: api/sceneview-android
full_commit_message: Dokka docs - sceneview-android
enable_jekyll: false
19 changes: 4 additions & 15 deletions arsceneview/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -68,20 +68,9 @@ mavenPublishing {
}

dokka {
moduleName.set("SceneView Android")
dokkaSourceSets.configureEach {
externalDocumentationLinks.register("example-docs") {
url("https://example.com/docs/")
packageListUrl("https://example.com/docs/package-list")
}
}
moduleName.set("ArSceneView Android - 3D and AR")
dokkaSourceSets.main {
includes.from("README.md")
sourceLink {
localDirectory.set(file("src/main/kotlin"))
remoteUrl("https://example.com/src")
remoteLineSuffix.set("#L")
}
includes.from("../README.md")
reportUndocumented.set(true)
skipEmptyPackages.set(true)
skipDeprecated.set(true)
Expand All @@ -103,9 +92,9 @@ dokka {
}

sourceLink {
localDirectory.set(project.file("src/main/kotlin"))
localDirectory.set(project.file("src/main/java"))
// URL showing where the source code can be accessed through the web browser
remoteUrl("https://github.com/sceneview/sceneview-android/blob/main/${project.name}/src/main/kotlin")
remoteUrl("https://github.com/sceneview/sceneview-android/tree/main/${project.name}/src/main/java")
// Suffix which is used to append the line number to the URL. Use #L for GitHub
remoteLineSuffix.set("#L")
}
Expand Down
11 changes: 11 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,15 @@ plugins {
alias(libs.plugins.compose.compiler ) apply false
alias(libs.plugins.publish) apply false
alias { libs.plugins.dokka } apply true
}

dokka {
dokkaPublications.html {
includes.from(project.layout.projectDirectory.file("README.md"))
}
}

dependencies {
dokka(projects.arsceneview)
dokka(projects.sceneview)
}
19 changes: 4 additions & 15 deletions sceneview/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,9 @@ mavenPublishing {
}

dokka {
moduleName.set("SceneView Android")
dokkaSourceSets.configureEach {
externalDocumentationLinks.register("example-docs") {
url("https://example.com/docs/")
packageListUrl("https://example.com/docs/package-list")
}
}
moduleName.set("SceneView Android - 3D")
dokkaSourceSets.main {
includes.from("README.md")
sourceLink {
localDirectory.set(file("src/main/kotlin"))
remoteUrl("https://example.com/src")
remoteLineSuffix.set("#L")
}
includes.from("../README.md")
reportUndocumented.set(true)
skipEmptyPackages.set(true)
skipDeprecated.set(true)
Expand All @@ -112,9 +101,9 @@ dokka {
}

sourceLink {
localDirectory.set(project.file("src/main/kotlin"))
localDirectory.set(project.file("src/main/java"))
// URL showing where the source code can be accessed through the web browser
remoteUrl("https://github.com/sceneview/sceneview-android/blob/main/${project.name}/src/main/kotlin")
remoteUrl("https://github.com/sceneview/sceneview-android/tree/main/${project.name}/src/main/java")
// Suffix which is used to append the line number to the URL. Use #L for GitHub
remoteLineSuffix.set("#L")
}
Expand Down