marco.lied
03/15/2021, 9:38 AM1.4.20
), which I try to migrate our 0.9.18
setup to:
The includes
are not used like in the old dokka before. We have a README.md
with the # Module <module-name>
tag but the README.md
seems not to be parsed and added tot the dokka outout.
No matter if I use includes.setFrom(files("README.md"))
or includes.from(files("README.md"))
Can I somehow trace if the README.md
is used correctly? --debug
does not report any meaningful information hereSiggi Gunnarss
03/15/2021, 10:38 AMtasks.dokkaHtml.configure {
dokkaSourceSets {
configureEach {
includes.from("README.md")
the other syntaxes on the dokka documentation failed for me for some reason, i didn't dig into itmarco.lied
03/15/2021, 10:46 AMmarco.lied
03/15/2021, 10:46 AMSiggi Gunnarss
03/15/2021, 10:49 AMKamil Doległo
03/15/2021, 12:35 PMKamil Doległo
03/15/2021, 12:36 PMmarco.lied
03/15/2021, 3:09 PMtasks.dokkaHtml.configure {
outputDirectory = new File(buildDir, "javadoc")
dokkaSourceSets {
named("main") {
// Do not create index pages for empty packages
skipEmptyPackages = true
// Do not output deprecated members. Applies globally, can be overridden by packageOptions
skipDeprecated = false
// Emit warnings about not documented members. Applies globally, also can be overridden by packageOptions
reportUndocumented = true
// Platform used for code analysis. See the "Platforms" section of this readme
platform.set(org.jetbrains.dokka.Platform.jvm)
// Used for linking to JDK documentation
jdkVersion = 8
// Disable linking to online kotlin-stdlib documentation
noStdlibLink = false
// Disable linking to online JDK documentation
noJdkLink = false
// Disable linking to online Android documentation (only applicable for Android projects)
noAndroidSdkLink = false
includes.from("README.md")
// includes.from(files(project.ext.dokkaIncludes))
}
}
}
marco.lied
03/15/2021, 3:09 PMmarco.lied
03/15/2021, 3:10 PMREADME.md
is normally injected through an ext propKamil Doległo
03/15/2021, 3:11 PMKamil Doległo
03/15/2021, 3:11 PM=
operatorKamil Doległo
03/15/2021, 3:11 PMset()
instead of =
Kamil Doległo
03/15/2021, 3:11 PMKamil Doległo
03/15/2021, 3:12 PMplatforms
is no longer neededKamil Doległo
03/15/2021, 3:15 PM.kts
files instead of Groovy ones. You’ll get code completion and meaningful error messages. This wouldn’t even compile without set()
and would be debuggable much easier. Also you can always mix .kts
and non-kts files, if you don’t want to migrate the whole codebasemarco.lied
03/15/2021, 5:25 PM.kts
switch is difficult we have about 70 single frameworks to maintain and switching the complete gradle setup is a huge effort heremarco.lied
03/16/2021, 10:15 AMset
and everything works 🎉marco.lied
03/16/2021, 10:16 AMKamil Doległo
03/16/2021, 2:38 PMmarco.lied
03/17/2021, 9:07 AMapply plugin: 'kotlin-android'
and apply plugin: 'com.android.library'
so we are building only android libraries.
And another question: Can I somehow deactivate the search bar or fix it, that it works locally? We’re not hosting the docs we are just shipping them, but the search is not working and in the Safari analyze it’s said, that this script is only allowed to run with HTTP.marco.lied
03/17/2021, 9:08 AMKamil Doległo
03/17/2021, 2:16 PMMarcin Aman
03/17/2021, 2:21 PMmarco.lied
03/18/2021, 7:54 AM0.9.18
style didn’t had this requirement.
But there is no setting to not generate the search or navigation bar? So we need to patch the CSS or generated HTML manually?Marcin Aman
03/18/2021, 12:15 PMmarco.lied
03/18/2021, 12:28 PMmarco.lied
03/18/2021, 12:29 PMleftColumn
in the sytles.css seem to fit my purpose, but it would be nicer to add an offline output format or so.