tree: c5b0db00962890d905ff0b31a236165cc85edb4c [path history] [tgz]
  1. README.md
  2. build.gradle
  3. deploy.sh
  4. docs/
site/README.md

Reference documentation site

This module builds references documentation.

Building

  • Install Jekyll
  • If you already have Ruby/Jekyll installed you might need to update its version:
    • cd site/docs
    • bundle install
  • In project root directory do:
    • Run ./gradlew site
  • The result is in site/build/gh-pages/_site
  • Upload it to github pages (gh-pages branch)