Skip to content

Commit

Permalink
build: cleanup and standardize docs build file (#52)
Browse files Browse the repository at this point in the history 
- Consolidate `jvmArgs` specification to a single location
- Leverage `layout`
- Standardize quotes by eliminating the mix of single and double quotes
- Adopt `=` syntax for property setters
  • Loading branch information
@matrei
matrei authored Dec 10, 2024
1 parent dfc6776 commit af6bd29
Showing 1 changed file with 57 additions and 59 deletions.
116 changes: 57 additions & 59 deletions docs/build.gradle
View file
Original file line number Diff line number Diff line change
@@ -1,45 +1,47 @@
import org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask

buildscript {
repositories {
maven { url 'https://repo.grails.org/grails/core' }
maven { url = 'https://repo.grails.org/grails/core' }
}
dependencies {
classpath 'org.asciidoctor:asciidoctor-gradle-jvm:4.0.3'
classpath "org.asciidoctor:asciidoctor-gradle-jvm-epub:4.0.3"
classpath "org.asciidoctor:asciidoctor-gradle-jvm-pdf:4.0.3"
classpath "org.asciidoctor:asciidoctor-gradle-jvm-gems:4.0.3"
classpath 'org.asciidoctor:asciidoctor-gradle-jvm-epub:4.0.3'
classpath 'org.asciidoctor:asciidoctor-gradle-jvm-pdf:4.0.3'
classpath 'org.asciidoctor:asciidoctor-gradle-jvm-gems:4.0.3'
}
}

apply plugin: "org.asciidoctor.jvm.gems"
apply plugin: 'org.asciidoctor.jvm.gems'
apply plugin: 'org.asciidoctor.jvm.convert'
apply plugin: "org.asciidoctor.jvm.pdf"
apply plugin: "org.asciidoctor.jvm.epub"
apply plugin: 'org.asciidoctor.jvm.pdf'
apply plugin: 'org.asciidoctor.jvm.epub'

def asciidoctorAttributes = [
copyright : 'Apache License, Version 2.0',
docinfo1 : 'true',
doctype : 'book',
encoding : 'utf-8',
icons : 'font',
id : project.name + ':' + project.version,
idprefix : '',
idseparator : '-',
lang : 'en',
linkattrs : true,
numbered : '',
producer : 'Asciidoctor',
revnumber : project.projectVersion,
setanchors : true,
copyright : 'Apache License, Version 2.0',
docinfo1 : 'true',
doctype : 'book',
encoding : 'utf-8',
icons : 'font',
id : project.name + ':' + project.version.toString(),
idprefix : '',
idseparator : '-',
lang : 'en',
linkattrs : true,
numbered : '',
producer : 'Asciidoctor',
revnumber : project.projectVersion,
setanchors : true,
'source-highlighter' : 'prettify',
toc : 'left',
toc2 : '',
toclevels : '2',
projectVersion : project.projectVersion,
toc : 'left',
toc2 : '',
toclevels : '2',
projectVersion : project.projectVersion,
]

repositories {
mavenCentral()
maven { url 'https://repo.grails.org/grails/core' }
maven { url = 'https://repo.grails.org/grails/core' }
ruby.gems()
}

Expand All @@ -48,78 +50,74 @@ dependencies {
}

asciidoctor {
sourceDir file('src/docs')
dependsOn 'asciidoctorPdf', 'asciidoctorEpub'
sourceDir layout.projectDirectory.dir('src/docs')
sources {
include 'index.adoc'
}
outputDir = new File(buildDir, 'docs')
outputDir = layout.buildDirectory.dir('docs')
attributes asciidoctorAttributes
executionMode = 'JAVA_EXEC'
forkOptions {
jvmArgs "--add-opens", "java.base/sun.nio.ch=ALL-UNNAMED", "--add-opens", "java.base/java.io=ALL-UNNAMED"
}
}

asciidoctorPdf {
dependsOn asciidoctorGemsPrepare
sourceDir = file('src/docs')
dependsOn 'asciidoctorGemsPrepare'
sourceDir = layout.projectDirectory.dir('src/docs')
sources {
include 'index.adoc'
}
outputDir = new File(buildDir, 'docs')
outputDir = layout.buildDirectory.dir('docs')
executionMode = 'JAVA_EXEC'
forkOptions {
jvmArgs "--add-opens", "java.base/sun.nio.ch=ALL-UNNAMED", "--add-opens", "java.base/java.io=ALL-UNNAMED"
}

asciidoctorj {
requires 'rouge'
attributes asciidoctorAttributes
}
}

asciidoctorEpub {
dependsOn asciidoctorGemsPrepare
sourceDir = file('src/docs')
dependsOn 'asciidoctorGemsPrepare'
sourceDir = layout.projectDirectory.dir('src/docs')
sources {
include 'index.adoc'
}
outputDir = new File(buildDir, 'docs')
outputDir = layout.buildDirectory.dir('docs')
executionMode = 'JAVA_EXEC'
forkOptions {
jvmArgs "--add-opens", "java.base/sun.nio.ch=ALL-UNNAMED", "--add-opens", "java.base/java.io=ALL-UNNAMED"
}

asciidoctorj {
requires 'rouge'
attributes asciidoctorAttributes
}

ebookFormats = ["EPUB3"]
ebookFormats = ['EPUB3']
}

tasks.named("asciidoctor").configure {
dependsOn = ['asciidoctorPdf', 'asciidoctorEpub']
}

tasks.register("docs") {
group = "documentation"
dependsOn = ["asciidoctor"]
tasks.register('docs') {
group = 'documentation'
dependsOn 'asciidoctor'
doLast {
File dir = new File(buildDir, 'docs')
File docsOutputDir = layout.buildDirectory.dir('docs').get().asFile
['epub', 'pdf'].each { String ext ->
File f = new File(dir, 'index.' + ext)
if (f.exists()) {
f.renameTo new File(dir, project.name + '.' + ext)
File indexFile = new File(docsOutputDir, "index.$ext")
if (indexFile.exists()) {
indexFile.renameTo(new File(docsOutputDir, "${project.name}.$ext"))
}
}

new File(buildDir, 'docs/ghpages.html') << file('src/docs/index.tmpl').text.replaceAll('@VERSION@', project.version)
File templateFile = layout.projectDirectory.file('src/docs/index.tmpl').asFile
File ghPagesFile = layout.buildDirectory.file('docs/ghpages.html').get().asFile
ghPagesFile << templateFile.text.replaceAll('@VERSION@', project.version.toString())

copy {
from 'src/docs'
into new File(buildDir, 'docs').path
from layout.projectDirectory.dir('src/docs')
into layout.buildDirectory.dir('docs')
include '**/*.png'
}
}
}

tasks.withType(AbstractAsciidoctorTask).configureEach {
jvm {
/* asciidoctorGemsPrepare is still issuing a warning: https://github.com/asciidoctor/asciidoctor-gradle-plugin/issues/666 */
jvmArgs '--add-opens', 'java.base/sun.nio.ch=ALL-UNNAMED', '--add-opens', 'java.base/java.io=ALL-UNNAMED'
}
}

0 comments on commit af6bd29

Please sign in to comment.