File tree 2 files changed +13
-11
lines changed
2 files changed +13
-11
lines changed Original file line number Diff line number Diff line change @@ -53,7 +53,8 @@ To release new `<version>` of `kotlinx-coroutines`:
53
53
* Create a release named ` <version> ` .
54
54
* Cut & paste lines from [ ` CHANGES.md ` ] ( CHANGES.md ) into description.
55
55
56
- 3 . Build and publish documentation for web-site: <br >
56
+ 3 . Build and publish documentation for web-site
57
+ (make sure you have [ Docker] ( https://www.docker.com/ ) installed first): <br >
57
58
` site/deploy.sh <version> push `
58
59
59
60
4 . In [ Bintray] ( https://bintray.com/kotlin/kotlinx/kotlinx.coroutines ) admin interface:
Original file line number Diff line number Diff line change 2
2
3
3
This module builds references documentation.
4
4
5
- ## Building
6
-
7
- * Install [ Jekyll] ( https://jekyllrb.com )
8
- * If you already have Ruby/Jekyll installed you might need to update its version:
9
- * ` cd site/docs `
10
- * ` bundle install `
11
- * In project root directory do:
12
- * Run ` ./gradlew site `
13
- * The result is in ` site/build/gh-pages/_site `
14
- * Upload it to github pages (` gh-pages ` branch)
5
+ ## Building docs
6
+
7
+ * Install [ Docker] ( https://www.docker.com/ )
8
+ * In the project root directory run ` ./gradlew site `
9
+ * The resulting HTML pages are generated in ` site/build/dist `
10
+ * For continuous testing of the documentation run ` ./gradlew serve ` and navigate
11
+ to the URL that is printed on the screen
12
+ * Update the docs via ` ./gradlew copyDocs ` while ` serve ` is running
13
+
14
+ For release use [ ` deploy.sh ` ] ( deploy.sh ) that performs clean build of the site and pushes the results
15
+ into ` gh-pages ` branch of the project.
You can’t perform that action at this time.
0 commit comments