Site module to generate reference documentation

kotlinx-coroutines-core/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-core</artifactId>
  <packaging>jar</packaging>
 
- <name>Kotlin coroutines core library</name>
-
  <properties>
  <kotlin.compiler.jdkHome>${env.JDK_16}</kotlin.compiler.jdkHome>
  </properties>

kotlinx-coroutines-javafx/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-javafx</artifactId>
  <packaging>jar</packaging>
 
- <name>Kotlin coroutines JavaFx library</name>
-
  <build>
  <sourceDirectory>src/main/kotlin</sourceDirectory>
  <testSourceDirectory>src/test/kotlin</testSourceDirectory>

kotlinx-coroutines-jdk8/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-jdk8</artifactId>
  <packaging>jar</packaging>
 
- <name>Kotlin coroutines JDK8 support library</name>
-
  <build>
  <sourceDirectory>src/main/kotlin</sourceDirectory>
  <testSourceDirectory>src/test/kotlin</testSourceDirectory>

kotlinx-coroutines-nio/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-nio</artifactId>
  <packaging>jar</packaging>
 
- <name>Kotlin coroutines NIO library</name>
-
  <build>
  <sourceDirectory>src/main/kotlin</sourceDirectory>
  <testSourceDirectory>src/test/kotlin</testSourceDirectory>

kotlinx-coroutines-rx-example/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-rx-example</artifactId>
  <packaging>jar</packaging>
 
- <name>Example of asyncRx usage</name>
-
  <build>
  <sourceDirectory>src/main/kotlin</sourceDirectory>
  <plugins>

kotlinx-coroutines-rx/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-rx</artifactId>
  <packaging>jar</packaging>
 
- <name>Kotlin coroutines support for Rx library</name>
-
  <build>
  <sourceDirectory>src/main/kotlin</sourceDirectory>
  <testSourceDirectory>src/test/kotlin</testSourceDirectory>

kotlinx-coroutines-swing/pom.xml

@@ -28,8 +28,6 @@
  <artifactId>kotlinx-coroutines-swing</artifactId>
  <packaging>jar</packaging>
 
- <name>Kotlin coroutines Swing library</name>
-
  <build>
  <sourceDirectory>src/main/kotlin</sourceDirectory>
  <testSourceDirectory>src/test/kotlin</testSourceDirectory>

license/third_party/minima_LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Parker Moore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

pom.xml

@@ -26,8 +26,8 @@
  <version>0.7-beta-SNAPSHOT</version>
  <packaging>pom</packaging>
 
- <name>Kotlin coroutines libraries</name>
- <description>Basic implementation of coroutines libraries for Kotlin 1.1</description>
+ <description>Coroutines support libraries for Kotlin 1.1</description>
+
  <url>https://github.com/Kotlin/kotlinx.coroutines/</url>
 
  <licenses>
@@ -103,6 +103,7 @@
  <module>kotlinx-coroutines-nio</module>
  <module>kotlinx-coroutines-rx</module>
  <module>kotlinx-coroutines-rx-example</module>
+ <module>site</module>
  </modules>
 
  <dependencies>
@@ -121,31 +122,6 @@
  </dependencies>
 
  <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.jetbrains.kotlin</groupId>
- <artifactId>kotlin-maven-plugin</artifactId>
- <version>${kotlin.version}</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-source-plugin</artifactId>
- <version>2.4</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-release-plugin</artifactId>
- <version>2.5.2</version>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-deploy-plugin</artifactId>
- <version>2.8.2</version>
- </plugin>
- </plugins>
- </pluginManagement>
-
  <plugins>
  <plugin>
  <artifactId>maven-source-plugin</artifactId>
@@ -207,9 +183,53 @@
  <urlSuffix>#L</urlSuffix>
  </link>
  </sourceLinks>
- <outputFormat>gfm</outputFormat>
+ <includes>
+ <include>${project.basedir}/README.md</include>
+ </includes>
+ <outputFormat>kotlin-website</outputFormat>
+ </configuration>
+ </plugin>
+ <plugin>
+ <artifactId>maven-site-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
  </configuration>
  </plugin>
  </plugins>
+
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.jetbrains.kotlin</groupId>
+ <artifactId>kotlin-maven-plugin</artifactId>
+ <version>${kotlin.version}</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <version>2.4</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-release-plugin</artifactId>
+ <version>2.5.2</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-deploy-plugin</artifactId>
+ <version>2.8.2</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <version>2.19.1</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>3.3</version>
+ </plugin>
+ </plugins>
+ </pluginManagement>
  </build>
 </project>

site/README.md

@@ -0,0 +1,13 @@
+# Reference documentation site
+
+This module builds references documentation.
+
+## Building
+
+* Install [Jekyll](http:https://jekyllrb.com)
+* In project root directory do:
+ * Run `mvn clean`
+ * Run `mvn compile`
+ * Run `mvn site`
+* The result is in `target/_site`
+* Upload it to github pages (`gh-pages` branch) 

site/docs/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+# bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+
+gem "jekyll", "3.4.0"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

site/docs/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+ remote: https://rubygems.org/
+ specs:
+ addressable (2.5.0)
+ public_suffix (~> 2.0, >= 2.0.2)
+ colorator (1.1.0)
+ ffi (1.9.17)
+ forwardable-extended (2.6.0)
+ jekyll (3.4.0)
+ addressable (~> 2.4)
+ colorator (~> 1.0)
+ jekyll-sass-converter (~> 1.0)
+ jekyll-watch (~> 1.1)
+ kramdown (~> 1.3)
+ liquid (~> 3.0)
+ mercenary (~> 0.3.3)
+ pathutil (~> 0.9)
+ rouge (~> 1.7)
+ safe_yaml (~> 1.0)
+ jekyll-sass-converter (1.5.0)
+ sass (~> 3.4)
+ jekyll-watch (1.5.0)
+ listen (~> 3.0, < 3.1)
+ kramdown (1.13.2)
+ liquid (3.0.6)
+ listen (3.0.8)
+ rb-fsevent (~> 0.9, >= 0.9.4)
+ rb-inotify (~> 0.9, >= 0.9.7)
+ mercenary (0.3.6)
+ pathutil (0.14.0)
+ forwardable-extended (~> 2.6)
+ public_suffix (2.0.5)
+ rb-fsevent (0.9.8)
+ rb-inotify (0.9.8)
+ ffi (>= 0.5.0)
+ rouge (1.11.1)
+ safe_yaml (1.0.4)
+ sass (3.4.23)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ jekyll (= 3.4.0)
+ tzinfo-data
+
+RUBY VERSION
+ ruby 2.0.0p648
+
+BUNDLED WITH
+ 1.14.3

site/docs/_config.yml

@@ -0,0 +1,11 @@
+# Jekyll configuration file
+title: kotlinx.coroutines
+description: Library support for kotlin coroutines
+baseurl: "/kotlinx.coroutines"
+url: "https://kotlin.github.io"
+
+# Build settings
+markdown: kramdown
+exclude:
+ - Gemfile
+ - Gemfile.lock

site/docs/_includes/footer.html

@@ -0,0 +1,3 @@
+<footer class="site-footer">
+ <!-- empty -->
+</footer>

site/docs/_includes/head.html

@@ -0,0 +1,9 @@
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+ <meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+ <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
+ <link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
+</head>

site/docs/_includes/header.html

@@ -0,0 +1,5 @@
+<header class="site-header" role="banner">
+ <div class="wrapper">
+ <a class="site-title" href="{{ "/" | relative_url}}">{{ site.title | escape }}</a>
+ </div>
+</header>

site/docs/_layouts/api.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+ {% include head.html %}
+ <body>
+ {% include header.html %}
+ <main class="page-content" aria-label="Content">
+ <div class="wrapper">
+ {{ content }}
+ </div>
+ </main>
+ {% include footer.html %}
+ </body>
+</html>
+