Skip to content

Commit

Permalink
build(docs): fix guide docs generation
Browse files Browse the repository at this point in the history
Removed PDF and EPUB from `acl` and `cas` for now.
  • Loading branch information
matrei committed Feb 25, 2025
1 parent e5b0471 commit 90a687d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 140 deletions.
3 changes: 3 additions & 0 deletions gradle/docs-config.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ tasks.named('asciidoctor', AsciidoctorTask) {
sources { include 'index.adoc' }
outputDir = layout.buildDirectory.file('docs')
attributes asciidoctorAttributes
jvm {
jvmArgs '--add-opens', 'java.base/sun.nio.ch=ALL-UNNAMED', '--add-opens', 'java.base/java.io=ALL-UNNAMED'
}
}

tasks.register('docs') {
Expand Down
78 changes: 4 additions & 74 deletions plugin-acl/docs/build.gradle
Original file line number Diff line number Diff line change
@@ -1,22 +1,7 @@
import org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask

buildscript {
repositories {
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'
}
plugins {
id 'org.asciidoctor.jvm.convert'
}

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

def asciidoctorAttributes = [
copyright : 'Apache License, Version 2.0',
docinfo1 : 'true',
Expand All @@ -39,85 +24,30 @@ def asciidoctorAttributes = [
projectVersion : project.projectVersion,
]

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

dependencies {
asciidoctorGems 'rubygems:rouge:4.4.0'
}

asciidoctor {
dependsOn 'asciidoctorPdf', 'asciidoctorEpub'
sourceDir layout.projectDirectory.dir('src/docs')
sources {
include 'index.adoc'
}
outputDir = layout.buildDirectory.dir('docs')
attributes asciidoctorAttributes
executionMode = 'JAVA_EXEC'
}

asciidoctorPdf {
dependsOn 'asciidoctorGemsPrepare'
sourceDir = layout.projectDirectory.dir('src/docs')
sources {
include 'index.adoc'
}
outputDir = layout.buildDirectory.dir('docs')
executionMode = 'JAVA_EXEC'
asciidoctorj {
requires 'rouge'
attributes asciidoctorAttributes
}
}

asciidoctorEpub {
dependsOn 'asciidoctorGemsPrepare'
sourceDir = layout.projectDirectory.dir('src/docs')
sources {
include 'index.adoc'
}
outputDir = layout.buildDirectory.dir('docs')
executionMode = 'JAVA_EXEC'

asciidoctorj {
requires 'rouge'
attributes asciidoctorAttributes
jvm {
jvmArgs '--add-opens', 'java.base/sun.nio.ch=ALL-UNNAMED', '--add-opens', 'java.base/java.io=ALL-UNNAMED'
}

ebookFormats = ['EPUB3']
}

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

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 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'
}
}
70 changes: 4 additions & 66 deletions plugin-cas/docs/build.gradle
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
buildscript {
repositories {
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"
}
plugins {
id 'org.asciidoctor.jvm.convert'
}

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

def asciidoctorAttributes = [
copyright : 'Apache License, Version 2.0',
docinfo1 : 'true',
Expand All @@ -38,72 +25,23 @@ def asciidoctorAttributes = [
threeZeroXProjectVersion: '3.0.1'
]

repositories {
ruby.gems()
}

dependencies {
asciidoctorGems 'rubygems:rouge:4.4.0'
}


asciidoctor {
sourceDir file('src/docs')
sources {
include 'index.adoc'
}
outputDir = new File(buildDir, 'docs')
attributes asciidoctorAttributes
}

asciidoctorPdf {
dependsOn asciidoctorGemsPrepare
sourceDir = file('src/docs')
sources {
include 'index.adoc'
}
outputDir = new File(buildDir, 'docs')

asciidoctorj {
requires 'rouge'
attributes asciidoctorAttributes
jvm {
jvmArgs '--add-opens', 'java.base/sun.nio.ch=ALL-UNNAMED', '--add-opens', 'java.base/java.io=ALL-UNNAMED'
}
}

asciidoctorEpub {
dependsOn asciidoctorGemsPrepare
sourceDir = file('src/docs')
sources {
include 'index.adoc'
}
outputDir = new File(buildDir, 'docs')

asciidoctorj {
requires 'rouge'
attributes asciidoctorAttributes
}

ebookFormats = ["EPUB3"]
}

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

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

new File(buildDir, 'docs/ghpages.html') << file('src/docs/index.tmpl').text.replaceAll('@VERSION@', project.version)

copy {
from 'src/docs'
into new File(buildDir, 'docs').path
Expand Down

0 comments on commit 90a687d

Please sign in to comment.