From 5cebfce558acc78fe21ea7a77cc02bc9bf5116da Mon Sep 17 00:00:00 2001 From: Mirco Nasuti <mirco.nasuti@chuv.ch> Date: Tue, 5 Jul 2016 14:22:44 +0200 Subject: [PATCH] add line to generate auto-generate PDF doc --- README.md | 5 +++++ src/docker/build/build-in-docker.sh | 3 +++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index 872eb01df..3cdb8c03e 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,8 @@ This is the MIP backend. * Run the project: `./run.sh` * Show live logs: `./log.sh` (CTRL+C to quit) * Stop and remove the running container: `./halt.sh` + +## Generate PDF API documentation on build + +Uncomment the following line in src/docker/build/build-in-docker.sh : +`mvn swagger2markup:convertSwagger2markup asciidoctor:process-asciidoc` diff --git a/src/docker/build/build-in-docker.sh b/src/docker/build/build-in-docker.sh index 604669be4..1c389dc33 100644 --- a/src/docker/build/build-in-docker.sh +++ b/src/docker/build/build-in-docker.sh @@ -2,3 +2,6 @@ rm -r target/ mvn package -DskipTests -P dev + +# Uncomment to generate a PDF API documentation +# mvn swagger2markup:convertSwagger2markup asciidoctor:process-asciidoc -- GitLab