1
0
Fork 0
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.
hmz007 6d24f2138b
Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56)
3 years ago
..
docs Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
README.md Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
build.gradle.kts Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
deploy.sh Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 3 years ago
stdlib.package.list Rockchip Anroid12_SDK 20220721-rkr10 (e1522e56) 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 serve and navigate to the URL that is printed on the screen
    • Update the docs via ./gradlew copyDocs while serve is running

For release use deploy.sh that performs clean build of the site and pushes the results into gh-pages branch of the project.