Skip to content

WIP - Generate a pdf of the user guide #271

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

WIP - Generate a pdf of the user guide #271

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
11 changes: 9 additions & 2 deletions documentation/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,16 @@ task expandJavaDocIndexHtml(type: Copy) {
)
}

task generateUserGuidePDF(type : Exec) {
dependsOn generateUserGuideToc

workingDir "$buildDir/docs"

commandLine 'pandoc', '--pdf-engine=xelatex', '-s', '-o', 'user-guide.pdf', 'user-guide.md'
Comment on lines +102 to +106
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this specify task inputs and task outputs?
Inputs and outputs would enable Gradle to track up-to-date properly, and the task could even become build-cacheable in the future.

}

task generateDocumentation {
dependsOn(generateUserGuideToc, generateJavaDoc, expandJavaDocIndexHtml)
dependsOn(generateUserGuideToc, generateJavaDoc, expandJavaDocIndexHtml, generateUserGuidePDF)
doLast {
String docsFolder = "${buildDir}/docs-${docsVersion(jqwikVersion)}"
file(docsFolder).delete()
Expand Down Expand Up @@ -150,4 +158,3 @@ dependencies {
testImplementation("org.mockito:mockito-core:${mockitoVersion}")
testImplementation("org.assertj:assertj-core:${assertJVersion}")
}