diff --git a/README.md b/README.md index 872eb01df1516533342fe5ae94eee59c6aac0946..3cdb8c03e91eddfaa183f9b2f12b27ed93283846 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 604669be4a98e5b1026327561407c649a05ff450..1c389dc33511fa5626e5b7faa425ea81e6850ea9 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