GP-1981 - Updated help to allow authors to use theme image ids; updated

help to only allow modules that live on the classpath. Dpdating themd
documentation. Fixing gradle help build
This commit is contained in:
ghidragon
2022-10-20 14:09:21 -04:00
parent c86b884daf
commit 45c52e3cb9
105 changed files with 1660 additions and 569 deletions
+18 -5
View File
@@ -70,11 +70,11 @@ task indexHelp(type: JavaExec) {
group "private"
description "indexes the helps files for this module. [gradle/helpProject.gradle]"
File helpRootDir = file('src/main/help/help')
File outputFile = file("build/help/main/help/${project.name}_JavaHelpSearch")
dependsOn configurations.helpPath
dependsOn configurations.runtimeClasspath
inputs.dir helpRootDir
outputs.dir outputFile
@@ -132,12 +132,18 @@ task buildHelp(type: JavaExec, dependsOn: indexHelp) {
group rootProject.GHIDRA_GROUP
description " Builds the help for this module. [gradle/helpProject.gradle]\n"
outputs.upToDateWhen {false}
outputs.upToDateWhen {false} // TODO remove this. we should be able to get the inputs right
// the issue is if docs get changed in a dependant module,
// this modules needs to know to rebuild
File helpRootDir = file('src/main/help/help')
File outputDir = file('build/help/main/help')
inputs.dir helpRootDir
inputs.dir file('src/main/help');
File resourcesDir = file('src/main/resources')
if (resourcesDir.exists()) {
inputs.dir file('src/main/resources');
}
outputs.dir outputDir
mainClass = 'help.GHelpBuilder'
@@ -150,8 +156,15 @@ task buildHelp(type: JavaExec, dependsOn: indexHelp) {
// args '-debug' // print debug info
doFirst {
// this modules runtime classpath (contains jhall.jar)
classpath project(':Help').sourceSets.main.runtimeClasspath
// this module's runtime classpath (contains jhall.jar)
classpath project(':Help').sourceSets.main.runtimeClasspath
// include the classpath for the project using this Help gradle script plugin
classpath += project.sourceSets.main.runtimeClasspath
// since this runs BEFORE resources are copied, include the resources source dir in
// the classpath so the help validator can find them
classpath += files('src/main/resources')
configurations.helpPath.each {
args "-hp"