king
/
v811_spc009
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
v811_spc009/external/kotlinx.coroutines/site
History
jianglk.darker 7ee447c011
v811_spc009_project 		4 months ago
..
docs v811_spc009_project 4 months ago
README.md v811_spc009_project 4 months ago
build.gradle.kts v811_spc009_project 4 months ago
deploy.sh v811_spc009_project 4 months ago
stdlib.package.list v811_spc009_project 4 months 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.