diff --git a/.gitignore b/.gitignore
index c508c0c30..668968fe5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,4 +7,5 @@ build
!buildSrc/src/main/groovy/org/springframework/restdocs/build/
target
.idea
-*.iml
\ No newline at end of file
+*.iml
+.DS_Store
diff --git a/docs/build.gradle b/docs/build.gradle
index 9accb8cb5..a335143ef 100644
--- a/docs/build.gradle
+++ b/docs/build.gradle
@@ -7,6 +7,10 @@ repositories {
maven { url 'https://repo.spring.io/snapshot' }
}
+ext {
+ docResourcesVersion = '0.1.0.RELEASE'
+}
+
dependencies {
asciidoctor 'io.spring.asciidoctor:spring-asciidoctor-extensions:0.1.2.RELEASE'
testCompile project(':spring-restdocs-mockmvc')
@@ -21,11 +25,45 @@ dependencies {
tasks.findByPath("artifactoryPublish")?.enabled = false
+configurations {
+ docs
+}
+
+dependencies {
+ docs "io.spring.docresources:spring-doc-resources:${docResourcesVersion}@zip"
+}
+
+task prepareAsciidocBuild(type: Sync) {
+ dependsOn configurations.docs
+ from {
+ configurations.docs.collect { zipTree(it) }
+ }
+ from 'src/docs/asciidoc/'
+ into "$buildDir/asciidoc"
+}
+
asciidoctor {
+ dependsOn 'prepareAsciidocBuild'
+ sourceDir "$buildDir/asciidoc"
sources {
include 'index.adoc'
}
+ resources {
+ from(sourceDir) {
+ include 'images/*', 'css/*', 'js/**'
+ }
+ }
+ options doctype: 'book'
attributes 'revnumber': project.version,
+ 'icons': 'font',
+ docinfo: 'shared',
+ stylesdir: 'css/',
+ stylesheet: 'spring.css',
+ 'linkcss': true,
+ sectanchors: true,
+ 'source-highlighter=highlight.js',
+ 'highlightjsdir=js/highlight',
+ 'highlightjs-theme=atom-one-dark-reasonable',
'branch-or-tag': project.version.endsWith('SNAPSHOT') ? 'master': "v${project.version}"
inputs.files(sourceSets.test.java)
}
diff --git a/docs/src/docs/asciidoc/index.adoc b/docs/src/docs/asciidoc/index.adoc
index eee9257f8..0dfcb0158 100644
--- a/docs/src/docs/asciidoc/index.adoc
+++ b/docs/src/docs/asciidoc/index.adoc
@@ -1,13 +1,10 @@
= Spring REST Docs
Andy Wilkinson
-:doctype: book
-:icons: font
-:source-highlighter: highlightjs
:toc: left
-:toclevels: 3
+:toclevels: 4
:sectlinks:
-:examples-dir: ../../test/java
+:examples-dir: ../../src/test/java
:github: https://github.com/spring-projects/spring-restdocs
:source: {github}/tree/{branch-or-tag}
:samples: {source}/samples
@@ -28,4 +25,4 @@ include::customizing-requests-and-responses.adoc[]
include::configuration.adoc[]
include::working-with-asciidoctor.adoc[]
include::working-with-markdown.adoc[]
-include::contributing.adoc[]
\ No newline at end of file
+include::contributing.adoc[]
diff --git a/samples/junit5/build.gradle b/samples/junit5/build.gradle
index ec9666a63..a9bac880a 100644
--- a/samples/junit5/build.gradle
+++ b/samples/junit5/build.gradle
@@ -34,7 +34,7 @@ ext {
junitJupiterVersion = '5.0.0'
}
-ext['spring-restdocs.version'] = '2.0.3.BUILD-SNAPSHOT'
+ext['spring-restdocs.version'] = '2.0.4.BUILD-SNAPSHOT'
dependencies {
asciidoctor "org.springframework.restdocs:spring-restdocs-asciidoctor:${project.ext['spring-restdocs.version']}"
diff --git a/samples/rest-assured/build.gradle b/samples/rest-assured/build.gradle
index e544e1071..d70b3c9c2 100644
--- a/samples/rest-assured/build.gradle
+++ b/samples/rest-assured/build.gradle
@@ -31,7 +31,7 @@ ext {
snippetsDir = file('build/generated-snippets')
}
-ext['spring-restdocs.version'] = '2.0.3.BUILD-SNAPSHOT'
+ext['spring-restdocs.version'] = '2.0.4.BUILD-SNAPSHOT'
dependencies {
compile 'org.springframework.boot:spring-boot-starter-web'
diff --git a/samples/rest-notes-grails/build.gradle b/samples/rest-notes-grails/build.gradle
index d339e4c9b..8af0afb79 100644
--- a/samples/rest-notes-grails/build.gradle
+++ b/samples/rest-notes-grails/build.gradle
@@ -22,7 +22,7 @@ apply plugin: "idea"
apply plugin: "org.grails.grails-web"
ext {
- restDocsVersion = "2.0.3.BUILD-SNAPSHOT"
+ restDocsVersion = "2.0.4.BUILD-SNAPSHOT"
snippetsDir = file('src/docs/generated-snippets')
}
diff --git a/samples/rest-notes-slate/build.gradle b/samples/rest-notes-slate/build.gradle
index 3c17bccdc..e4a2bd3e4 100644
--- a/samples/rest-notes-slate/build.gradle
+++ b/samples/rest-notes-slate/build.gradle
@@ -27,7 +27,7 @@ ext {
snippetsDir = file('build/generated-snippets')
}
-ext['spring-restdocs.version'] = '2.0.3.BUILD-SNAPSHOT'
+ext['spring-restdocs.version'] = '2.0.4.BUILD-SNAPSHOT'
dependencies {
compile 'org.springframework.boot:spring-boot-starter-data-jpa'
diff --git a/samples/rest-notes-spring-data-rest/pom.xml b/samples/rest-notes-spring-data-rest/pom.xml
index 16b716db7..cf8faaceb 100644
--- a/samples/rest-notes-spring-data-rest/pom.xml
+++ b/samples/rest-notes-spring-data-rest/pom.xml
@@ -18,7 +18,7 @@
UTF-8
1.8
- 2.0.3.BUILD-SNAPSHOT
+ 2.0.4.BUILD-SNAPSHOT
diff --git a/samples/rest-notes-spring-hateoas/build.gradle b/samples/rest-notes-spring-hateoas/build.gradle
index 112fb41e7..131a6c296 100644
--- a/samples/rest-notes-spring-hateoas/build.gradle
+++ b/samples/rest-notes-spring-hateoas/build.gradle
@@ -31,7 +31,7 @@ ext {
snippetsDir = file('build/generated-snippets')
}
-ext['spring-restdocs.version'] = '2.0.3.BUILD-SNAPSHOT'
+ext['spring-restdocs.version'] = '2.0.4.BUILD-SNAPSHOT'
dependencies {
asciidoctor "org.springframework.restdocs:spring-restdocs-asciidoctor:${project.ext['spring-restdocs.version']}"
diff --git a/samples/testng/build.gradle b/samples/testng/build.gradle
index 9aef5712b..e8cec0a56 100644
--- a/samples/testng/build.gradle
+++ b/samples/testng/build.gradle
@@ -31,7 +31,7 @@ ext {
snippetsDir = file('build/generated-snippets')
}
-ext['spring-restdocs.version'] = '2.0.3.BUILD-SNAPSHOT'
+ext['spring-restdocs.version'] = '2.0.4.BUILD-SNAPSHOT'
dependencies {
asciidoctor "org.springframework.restdocs:spring-restdocs-asciidoctor:${project.ext['spring-restdocs.version']}"
diff --git a/samples/web-test-client/build.gradle b/samples/web-test-client/build.gradle
index 8d40e948b..90f07d3c5 100644
--- a/samples/web-test-client/build.gradle
+++ b/samples/web-test-client/build.gradle
@@ -20,7 +20,7 @@ ext {
snippetsDir = file('build/generated-snippets')
}
-ext['spring-restdocs.version'] = '2.0.3.BUILD-SNAPSHOT'
+ext['spring-restdocs.version'] = '2.0.4.BUILD-SNAPSHOT'
dependencies {
compile 'io.projectreactor.ipc:reactor-netty:0.7.1.RELEASE'