• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Reference documentation site
2
3This module builds references documentation.
4
5## Building docs
6
7* Install [Docker](https://www.docker.com/)
8* In the project root directory run `./gradlew site`
9* The resulting HTML pages are generated in `site/build/dist`
10* For continuous testing of the documentation run `./gradlew serve` and navigate
11  to the URL that is printed on the screen
12  * Update the docs via `./gradlew copyDocs` while `serve` is running
13
14For release use [`deploy.sh`](deploy.sh) that performs clean build of the site and pushes the results
15into `gh-pages` branch of the project.