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.
|
|
3 years ago | |
|---|---|---|
| .. | ||
| docs | 3 years ago | |
| README.md | 3 years ago | |
| build.gradle.kts | 3 years ago | |
| deploy.sh | 3 years ago | |
| stdlib.package.list | 3 years ago | |
README.md
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.