This module builds references documentation.
- Install Docker
- In the project root directory run
./gradlew site
- The resulting HTML pages are generated in
site/build/dist
- For continuous testing of the documentation run
./gradlew serve
and navigate to the URL that is printed on the screen- Update the docs via
./gradlew copyDocs
whileserve
is running
- Update the docs via
For release use deploy.sh
that performs clean build of the site and pushes the results
into gh-pages
branch of the project.