minor asciidoctor task improvements + update plugin to 3.1 version
This commit is contained in:
parent
3b78f30309
commit
be8be18bc0
|
@ -1,5 +1,8 @@
|
||||||
import org.apache.tools.ant.filters.ReplaceTokens
|
import org.asciidoctor.gradle.jvm.AsciidoctorTask
|
||||||
import org.asciidoctor.gradle.AsciidoctorTask
|
|
||||||
|
plugins {
|
||||||
|
id 'org.asciidoctor.jvm.convert' version '3.1.0'
|
||||||
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Hibernate, Relational Persistence for Idiomatic Java
|
* Hibernate, Relational Persistence for Idiomatic Java
|
||||||
|
@ -30,7 +33,6 @@ projectsToIncludeInAggregatedJavadoc.each {projectPath ->
|
||||||
}
|
}
|
||||||
|
|
||||||
apply from: rootProject.file( 'gradle/java-module.gradle' )
|
apply from: rootProject.file( 'gradle/java-module.gradle' )
|
||||||
apply plugin: 'org.asciidoctor.convert'
|
|
||||||
apply plugin: 'org.hibernate.matrix-test'
|
apply plugin: 'org.hibernate.matrix-test'
|
||||||
|
|
||||||
tasks.build.dependsOn 'buildDocs'
|
tasks.build.dependsOn 'buildDocs'
|
||||||
|
@ -163,30 +165,34 @@ task aggregateJavadocs(type: Javadoc) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tasks.asciidoctor {
|
|
||||||
// we do not want it creating its "default task"
|
asciidoctorj {
|
||||||
enabled = false
|
attributes icons: 'font',
|
||||||
|
experimental: true,
|
||||||
|
'source-highlighter': 'prettify',
|
||||||
|
majorMinorVersion: rootProject.ormVersion.family,
|
||||||
|
fullVersion: rootProject.ormVersion.fullName
|
||||||
|
|
||||||
|
options logDocuments: true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// Topical Guides ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
// Topical Guides ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
task renderTopicalGuides(type: AsciidoctorTask, group: 'Documentation') {
|
task renderTopicalGuides(type: AsciidoctorTask, group: 'Documentation') {
|
||||||
description = 'Renders the Topical Guides in HTML format using Asciidoctor.'
|
description = 'Renders the Topical Guides in HTML format using Asciidoctor.'
|
||||||
|
|
||||||
sourceDir = file( 'src/main/asciidoc/topical' )
|
sourceDir = file( 'src/main/asciidoc/topical' )
|
||||||
outputDir = new File("$buildDir/asciidoc/topical/html_single")
|
outputDir = new File("$buildDir/asciidoc/topical/html_single")
|
||||||
backends "html5"
|
|
||||||
separateOutputDirs false
|
baseDirFollowsSourceDir()
|
||||||
options logDocuments: true
|
|
||||||
attributes icons: 'font',
|
|
||||||
experimental: true,
|
|
||||||
'source-highlighter': 'prettify',
|
|
||||||
majorMinorVersion: rootProject.ormVersion.family,
|
|
||||||
fullVersion: rootProject.ormVersion.fullName
|
|
||||||
resources {
|
resources {
|
||||||
from('src/main/asciidoc/topical/') {
|
from('src/main/asciidoc/topical/') {
|
||||||
include '**/images/**'
|
include '**/images/**'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -194,15 +200,14 @@ task renderTopicalGuides(type: AsciidoctorTask, group: 'Documentation') {
|
||||||
|
|
||||||
task renderGettingStartedGuides(type: AsciidoctorTask, group: 'Documentation') {
|
task renderGettingStartedGuides(type: AsciidoctorTask, group: 'Documentation') {
|
||||||
description = 'Renders the Getting Started Guides (quick starts) in HTML format using Asciidoctor.'
|
description = 'Renders the Getting Started Guides (quick starts) in HTML format using Asciidoctor.'
|
||||||
|
|
||||||
sourceDir = file( 'src/main/asciidoc/quickstart/guides' )
|
sourceDir = file( 'src/main/asciidoc/quickstart/guides' )
|
||||||
sources {
|
sources {
|
||||||
include 'index.adoc'
|
include 'index.adoc'
|
||||||
}
|
}
|
||||||
outputDir = new File("$buildDir/asciidoc/quickstart/html_single")
|
outputDir = new File("$buildDir/asciidoc/quickstart/html_single")
|
||||||
backends "html5"
|
|
||||||
separateOutputDirs false
|
baseDirFollowsSourceDir()
|
||||||
options logDocuments: true
|
|
||||||
attributes icons: 'font', experimental: true, 'source-highlighter': 'prettify'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -224,20 +229,17 @@ renderGettingStartedGuides.dependsOn buildTutorialZip
|
||||||
|
|
||||||
task renderUserGuide(type: AsciidoctorTask, group: 'Documentation') {
|
task renderUserGuide(type: AsciidoctorTask, group: 'Documentation') {
|
||||||
description = 'Renders the User Guides in HTML format using Asciidoctor.'
|
description = 'Renders the User Guides in HTML format using Asciidoctor.'
|
||||||
|
|
||||||
sourceDir = file( 'src/main/asciidoc/userguide' )
|
sourceDir = file( 'src/main/asciidoc/userguide' )
|
||||||
sources {
|
sources {
|
||||||
include 'Hibernate_User_Guide.adoc'
|
include 'Hibernate_User_Guide.adoc'
|
||||||
}
|
}
|
||||||
outputDir = new File("$buildDir/asciidoc/userguide/html_single")
|
outputDir = new File("$buildDir/asciidoc/userguide/html_single")
|
||||||
backends "html5"
|
|
||||||
separateOutputDirs false
|
baseDirFollowsSourceDir()
|
||||||
options logDocuments: true
|
|
||||||
attributes icons: 'font', experimental: true,
|
attributes linkcss: true,
|
||||||
'source-highlighter': 'prettify',
|
|
||||||
linkcss: true,
|
|
||||||
stylesheet: "css/hibernate.css",
|
stylesheet: "css/hibernate.css",
|
||||||
majorMinorVersion: rootProject.ormVersion.family,
|
|
||||||
fullVersion: rootProject.ormVersion.fullName,
|
|
||||||
docinfo: 'private',
|
docinfo: 'private',
|
||||||
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
|
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
|
||||||
|
|
||||||
|
@ -261,20 +263,19 @@ task renderUserGuide(type: AsciidoctorTask, group: 'Documentation') {
|
||||||
|
|
||||||
task renderIntegrationGuide(type: AsciidoctorTask, group: 'Documentation') {
|
task renderIntegrationGuide(type: AsciidoctorTask, group: 'Documentation') {
|
||||||
description = 'Renders the User Guides in HTML format using Asciidoctor.'
|
description = 'Renders the User Guides in HTML format using Asciidoctor.'
|
||||||
|
|
||||||
sourceDir = file( 'src/main/asciidoc/integrationguide' )
|
sourceDir = file( 'src/main/asciidoc/integrationguide' )
|
||||||
sources {
|
sources {
|
||||||
include 'Hibernate_Integration_Guide.adoc'
|
include 'Hibernate_Integration_Guide.adoc'
|
||||||
}
|
}
|
||||||
|
|
||||||
outputDir = new File("$buildDir/asciidoc/integrationguide/html_single")
|
outputDir = new File("$buildDir/asciidoc/integrationguide/html_single")
|
||||||
backends "html5"
|
|
||||||
separateOutputDirs false
|
baseDirFollowsSourceDir()
|
||||||
options logDocuments: true
|
|
||||||
attributes icons: 'font',
|
attributes linkcss: true,
|
||||||
experimental: true,
|
stylesheet: "css/hibernate.css"
|
||||||
'source-highlighter': 'prettify',
|
|
||||||
linkcss: true,
|
|
||||||
stylesheet: "css/hibernate.css",
|
|
||||||
majorMinorVersion: rootProject.ormVersion.family
|
|
||||||
resources {
|
resources {
|
||||||
from('src/main/asciidoc/integrationguide/') {
|
from('src/main/asciidoc/integrationguide/') {
|
||||||
include 'images/**'
|
include 'images/**'
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[bootstrap]]
|
[[bootstrap]]
|
||||||
== Bootstrap
|
== Bootstrap
|
||||||
:sourcedir: ../../../../../test/java/org/hibernate/userguide/bootstrap
|
:sourcedir: ../../../../../test/java/org/hibernate/userguide/bootstrap
|
||||||
:boot-spi-sourcedir: ../../../../../../../hibernate-core/src/test/java/org/hibernate/boot/spi
|
:boot-spi-sourcedir: ../../../../../../../hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/spi
|
||||||
:extrasdir: extras
|
:extrasdir: extras
|
||||||
|
|
||||||
The term bootstrapping refers to initializing and starting a software component.
|
The term bootstrapping refers to initializing and starting a software component.
|
||||||
|
@ -328,6 +328,7 @@ https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/
|
||||||
include::{boot-spi-sourcedir}/metadatabuildercontributor/SqlFunctionMetadataBuilderContributor.java[tags=bootstrap-jpa-compliant-MetadataBuilderContributor-example]
|
include::{boot-spi-sourcedir}/metadatabuildercontributor/SqlFunctionMetadataBuilderContributor.java[tags=bootstrap-jpa-compliant-MetadataBuilderContributor-example]
|
||||||
----
|
----
|
||||||
====
|
====
|
||||||
|
org.hibernate.orm.test.bootstrap.spi.metadatabuildercontributor
|
||||||
|
|
||||||
The above `MetadataBuilderContributor` is used to register a `SqlFuction` which is not defined by the currently running Hibernate `Dialect`, but which we need to reference in our JPQL queries.
|
The above `MetadataBuilderContributor` is used to register a `SqlFuction` which is not defined by the currently running Hibernate `Dialect`, but which we need to reference in our JPQL queries.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue