Merge pull request #47 from grails/build-documentation

Build Documentation
grails · Nov 20, 2023 · be93772 · be93772
2 parents 987ac53 + 3d04bd8
commit be93772
Show file tree

Hide file tree

Showing 6 changed files with 201 additions and 146 deletions.
diff --git a/build.gradle b/build.gradle
@@ -1,12 +1,12 @@
 plugins {
     id 'groovy'
     id 'io.github.gradle-nexus.publish-plugin'
+    id "org.asciidoctor.jvm.convert" version "4.0.0-alpha.1"
 }
 
 version = projectVersion
 
 repositories {
-    mavenLocal()
     mavenCentral()
     maven { url 'https://repo.grails.org/grails/core' }
 }
@@ -34,6 +34,79 @@ if(isReleaseVersion) {
     }
 }
 
+configurations {
+    documentation.extendsFrom compileClasspath
+}
+
+dependencies {
+    documentation libs.groovy
+    documentation libs.groovy.templates
+    documentation libs.groovy.ant
+    documentation libs.groovy.dateutil
+    documentation libs.groovy.cli.picocli
+
+}
+
+tasks.withType(Groovydoc) {
+    group = "documentation"
+    docTitle = "${project.title} - ${project.version}"
+    destinationDir = project.file("build/docs/api")
+    def files = []
+    project.rootProject.subprojects
+            .findAll { !it.name != 'docs' && !it.name.startsWith('examples') }
+            .each { subproject ->
+                if(subproject.file('src/main/groovy').exists()) {
+                    files += subproject.files("src/main/groovy")
+                }
+            }
+    if(project.file('src/main/groovy').exists()) {
+        files += project.files("src/main/groovy")
+    }
+    source = files
+    classpath = configurations.documentation
+}
+
+task publishGuide(type: grails.doc.gradle.PublishGuide) {
+    group = "documentation"
+    description = 'Generate Guide'
+    dependsOn ["groovydoc"]
+
+    targetDir = project.file("${buildDir}/docs")
+    sourceRepo = "https://github.com/${githubSlug}/edit/${githubBranch}/src/main/docs"
+    sourceDir = new File(projectDir, "src/main/docs")
+    propertiesFiles = [ new File(rootProject.projectDir, "gradle.properties") ]
+    asciidoc = true
+    resourcesDir = project.layout.projectDirectory.dir("src/main/docs/resources").asFile
+    properties = [
+            'safe': 'UNSAFE',
+            'version': project.version,
+            'subtitle': project.projectDesc,
+            'api': '../api',
+            'sourceDir': rootProject.projectDir.absolutePath,
+            'sourcedir': rootProject.projectDir.absolutePath,
+            'javaee': 'https://docs.oracle.com/javaee/7/api/',
+            'javase': 'https://docs.oracle.com/en/java/javase/11/docs/api/',
+            'groovyapi': "https://docs.groovy-lang.org/${libs.versions.groovy.asProvider().get()}/html/gapi/",
+            'grailsapi': "https://docs.grails.org/${libs.versions.grails.asProvider().get()}/api/",
+            'gormapi': "https://gorm.grails.org/${libs.versions.gorm.get()}/api/",
+            'springapi': "https://docs.spring.io/spring/docs/${libs.versions.spring.get()}/javadoc-api/"
+    ]
+    doLast {
+        ant.move(file:"${project.buildDir}/docs/guide/single.html",
+                tofile:"${project.buildDir}/docs/guide/index.html", overwrite:true)
+        new File(project.buildDir, "docs/index.html").text = '''
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<meta http-equiv="refresh" content="0; url=guide/index.html" />
+</head>
+
+</body>
+</html>
+'''
+    }
+}
+
 subprojects {
 
     version = rootProject.version

diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
@@ -1,8 +1,6 @@
 plugins {
-
     id 'groovy-gradle-plugin'
     id 'maven-publish'
-
 }
 
 repositories {
@@ -11,10 +9,9 @@ repositories {
 }
 
 dependencies {
-
     implementation libs.nexus.publish.gradle.plugin
     implementation libs.grails.gradle.plugin
     implementation libs.grails.views.gradle.plugin
     implementation libs.groovydoc.gradle.plugin
-
+    implementation libs.grails.docs
 }
diff --git a/gradle/documentation.gradle b/gradle/documentation.gradle
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -19,12 +19,15 @@ spock = '2.1-groovy-3.0'
 spring = '5.3.30'
 
 [libraries]
+grails-docs = { module = "org.grails:grails-docs", version.ref = "grails" }
 gpars = { module = 'org.codehaus.gpars:gpars', version.ref = 'gpars' }
 gorm = { module = 'org.grails:grails-datastore-gorm', version.ref = 'gorm' }
 gorm-test = { module = 'org.grails:grails-datastore-gorm-test', version.ref = 'gorm' }
 groovy = { module = 'org.codehaus.groovy:groovy', version.ref = 'groovy' }
-#groovy-ant = { module = 'org.codehaus.groovy:groovy-ant', version.ref = 'groovy' }
-#groovy-cli-picocli = { module = 'org.codehaus.groovy:groovy-cli-picocli', version.ref = 'groovy' }
+groovy-templates = { module = 'org.codehaus.groovy:groovy-templates', version.ref = 'groovy' }
+groovy-ant = { module = 'org.codehaus.groovy:groovy-ant', version.ref = 'groovy' }
+groovy-dateutil = { module = 'org.codehaus.groovy:groovy-dateutil', version.ref = 'groovy' }
+groovy-cli-picocli = { module = 'org.codehaus.groovy:groovy-cli-picocli', version.ref = 'groovy' }
 jansi = { module = 'org.fusesource.jansi:jansi', version.ref = 'jansi' }
 javaparser-core = { module = 'com.github.javaparser:javaparser-core', version.ref = 'javaparser' }
 javax-annotation-api = { module = 'javax.annotation:javax.annotation-api', version.ref = 'javax-annotation' }

diff --git a/settings.gradle b/settings.gradle
@@ -26,5 +26,5 @@ include 'grails-plugin-async'
 include 'grails-plugin-events'
 
 // examples
-include 'pubsub-demo'
-project(':pubsub-demo').projectDir = new File(settingsDir, 'examples/pubsub-demo')
+include 'examples-pubsub-demo'
+project(':examples-pubsub-demo').projectDir = new File(settingsDir, 'examples/pubsub-demo')