Skip to content
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.

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

feat: added dokka templates directory for kotlinlang #377

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

berezinant
Copy link

@berezinant berezinant commented Aug 22, 2024

We're adding kotlinx-io api reference to kotlinlang and we need to customise templates for that

@berezinant berezinant marked this pull request as ready for review September 12, 2024 09:05
Copy link
Collaborator

@fzhinkin fzhinkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@berezinant thank you for working on docs publication!

There are a few minor changes that could slightly improve build scripts, but otherwise the change looks good.

@@ -44,3 +44,6 @@ kover {
}
}
}
tasks.dokkaHtmlMultiModule {
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""))
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${projectDir.resolve("dokka-templates")}" }"""))

Or there's a reason to manually replace backslashes?

@@ -44,3 +44,6 @@ kover {
}
}
}
tasks.dokkaHtmlMultiModule {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please move this config setup to kotlinx-io-dokka.gradle.kts too?
I guess, dokkaHtmlMultiModule would need to be replaced with withType(DokkaMultiModuleTask::class.java).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants