You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
590 B
590 B
Reference documentation site
This module builds references documentation.
Building docs
- 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 serveand navigate to the URL that is printed on the screen- Update the docs via
./gradlew copyDocswhileserveis 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.