Skip to content

Give PDF user guide a better name #2314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcphilipp merged 1 commit into from
Jun 5, 2020
Merged

Give PDF user guide a better name #2314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions documentation/documentation.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ val releaseBranch = if (snapshot) "master" else "r${rootProject.version}"
val docsDir = file("$buildDir/ghpages-docs")
val replaceCurrentDocs = project.hasProperty("replaceCurrentDocs")
val uploadPdfs = !snapshot
val userGuidePdfFileName = "junit-user-guide-${rootProject.version}.pdf"
val ota4jDocVersion = if (versions.opentest4j.contains("SNAPSHOT")) "snapshot" else versions.opentest4j
val apiGuardianDocVersion = if (versions.apiguardian.contains("SNAPSHOT")) "snapshot" else versions.apiguardian

Expand Down Expand Up @@ -136,10 +137,6 @@ tasks {
dependsOn(generateConsoleLauncherOptions, generateExperimentalApisTable, generateDeprecatedApisTable)
inputs.files(consoleLauncherOptionsFile, experimentalApisTableFile, deprecatedApisTableFile)

sources {
include("**/index.adoc")
}

resources {
from(sourceDir) {
include("**/images/**/*.png")
Expand All @@ -148,7 +145,6 @@ tasks {
}

attributes(mapOf(
"linkToPdf" to uploadPdfs,
"jupiter-version" to version,
"platform-version" to project.property("platformVersion"),
"vintage-version" to project.property("vintageVersion"),
Expand Down Expand Up @@ -188,15 +184,27 @@ tasks {
}

asciidoctor {
sources {
include("**/index.adoc")
}
resources {
from(sourceDir) {
include("tocbot-*/**")
}
}
attributes(mapOf(
"linkToPdf" to uploadPdfs,
"userGuidePdfFileName" to userGuidePdfFileName,
"releaseNotesUrl" to "../release-notes/index.html#release-notes"
))
}

asciidoctorPdf {
sources {
include("user-guide/index.adoc")
}
copyAllResources()
attributes(mapOf("releaseNotesUrl" to "https://junit.org/junit5/docs/$docsVersion/release-notes/"))
}

val downloadJavadocElementLists by registering {
Expand Down Expand Up @@ -326,6 +334,7 @@ tasks {
if (uploadPdfs) {
from(asciidoctorPdf.map { it.outputDir }) {
include("**/*.pdf")
rename { userGuidePdfFileName }
}
}
from(fixJavadoc.map { it.destinationDir }) {
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/docs/asciidoc/user-guide/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ include::{basedir}/contributors.adoc[]
[[release-notes]]
== Release Notes

The release notes are available <<../release-notes/index.adoc#release-notes,here>>.
The release notes are available link:{releaseNotesUrl}[here].

include::{basedir}/appendix.adoc[]
6 changes: 3 additions & 3 deletions documentation/src/docs/asciidoc/user-guide/overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ The goal of this document is to provide comprehensive reference documentation fo
programmers writing tests, extension authors, and engine authors as well as build tool
and IDE vendors.

ifdef::linkToPdf[]
ifdef::backend-html5[]
This document is also available as a link:index.pdf[PDF download].
endif::backend-html5[]
ifdef::linkToPdf[]
This document is also available as a link:{userGuidePdfFileName}[PDF download].
endif::linkToPdf[]
endif::backend-html5[]

[[overview-what-is-junit-5]]
=== What is JUnit 5?
Expand Down