Skip to content

Commit d6b5a7b

Browse files
elizarovelizarov
committed
Site module to generate reference documentation
1 parent 0216426 commit d6b5a7b

File tree

24 files changed

+1051
-42
lines changed

24 files changed

+1051
-42
lines changed

‎kotlinx-coroutines-core/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-core</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Kotlin coroutines core library</name>
32-
3331
<properties>
3432
<kotlin.compiler.jdkHome>${env.JDK_16}</kotlin.compiler.jdkHome>
3533
</properties>

‎kotlinx-coroutines-javafx/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-javafx</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Kotlin coroutines JavaFx library</name>
32-
3331
<build>
3432
<sourceDirectory>src/main/kotlin</sourceDirectory>
3533
<testSourceDirectory>src/test/kotlin</testSourceDirectory>

‎kotlinx-coroutines-jdk8/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-jdk8</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Kotlin coroutines JDK8 support library</name>
32-
3331
<build>
3432
<sourceDirectory>src/main/kotlin</sourceDirectory>
3533
<testSourceDirectory>src/test/kotlin</testSourceDirectory>

‎kotlinx-coroutines-nio/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-nio</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Kotlin coroutines NIO library</name>
32-
3331
<build>
3432
<sourceDirectory>src/main/kotlin</sourceDirectory>
3533
<testSourceDirectory>src/test/kotlin</testSourceDirectory>

‎kotlinx-coroutines-rx-example/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-rx-example</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Example of asyncRx usage</name>
32-
3331
<build>
3432
<sourceDirectory>src/main/kotlin</sourceDirectory>
3533
<plugins>

‎kotlinx-coroutines-rx/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-rx</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Kotlin coroutines support for Rx library</name>
32-
3331
<build>
3432
<sourceDirectory>src/main/kotlin</sourceDirectory>
3533
<testSourceDirectory>src/test/kotlin</testSourceDirectory>

‎kotlinx-coroutines-swing/pom.xml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
<artifactId>kotlinx-coroutines-swing</artifactId>
2929
<packaging>jar</packaging>
3030

31-
<name>Kotlin coroutines Swing library</name>
32-
3331
<build>
3432
<sourceDirectory>src/main/kotlin</sourceDirectory>
3533
<testSourceDirectory>src/test/kotlin</testSourceDirectory>

‎license/third_party/minima_LICENSE.txt‎

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

‎pom.xml‎

Lines changed: 48 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
<version>0.7-beta-SNAPSHOT</version>
2727
<packaging>pom</packaging>
2828

29-
<name>Kotlin coroutines libraries</name>
30-
<description>Basic implementation of coroutines libraries for Kotlin 1.1</description>
29+
<description>Coroutines support libraries for Kotlin 1.1</description>
30+
3131
<url>https://github.com/Kotlin/kotlinx.coroutines/</url>
3232

3333
<licenses>
@@ -103,6 +103,7 @@
103103
<module>kotlinx-coroutines-nio</module>
104104
<module>kotlinx-coroutines-rx</module>
105105
<module>kotlinx-coroutines-rx-example</module>
106+
<module>site</module>
106107
</modules>
107108

108109
<dependencies>
@@ -121,31 +122,6 @@
121122
</dependencies>
122123

123124
<build>
124-
<pluginManagement>
125-
<plugins>
126-
<plugin>
127-
<groupId>org.jetbrains.kotlin</groupId>
128-
<artifactId>kotlin-maven-plugin</artifactId>
129-
<version>${kotlin.version}</version>
130-
</plugin>
131-
<plugin>
132-
<groupId>org.apache.maven.plugins</groupId>
133-
<artifactId>maven-source-plugin</artifactId>
134-
<version>2.4</version>
135-
</plugin>
136-
<plugin>
137-
<groupId>org.apache.maven.plugins</groupId>
138-
<artifactId>maven-release-plugin</artifactId>
139-
<version>2.5.2</version>
140-
</plugin>
141-
<plugin>
142-
<groupId>org.apache.maven.plugins</groupId>
143-
<artifactId>maven-deploy-plugin</artifactId>
144-
<version>2.8.2</version>
145-
</plugin>
146-
</plugins>
147-
</pluginManagement>
148-
149125
<plugins>
150126
<plugin>
151127
<artifactId>maven-source-plugin</artifactId>
@@ -207,9 +183,53 @@
207183
<urlSuffix>#L</urlSuffix>
208184
</link>
209185
</sourceLinks>
210-
<outputFormat>gfm</outputFormat>
186+
<includes>
187+
<include>${project.basedir}/README.md</include>
188+
</includes>
189+
<outputFormat>kotlin-website</outputFormat>
190+
</configuration>
191+
</plugin>
192+
<plugin>
193+
<artifactId>maven-site-plugin</artifactId>
194+
<configuration>
195+
<skip>true</skip>
211196
</configuration>
212197
</plugin>
213198
</plugins>
199+
200+
<pluginManagement>
201+
<plugins>
202+
<plugin>
203+
<groupId>org.jetbrains.kotlin</groupId>
204+
<artifactId>kotlin-maven-plugin</artifactId>
205+
<version>${kotlin.version}</version>
206+
</plugin>
207+
<plugin>
208+
<groupId>org.apache.maven.plugins</groupId>
209+
<artifactId>maven-source-plugin</artifactId>
210+
<version>2.4</version>
211+
</plugin>
212+
<plugin>
213+
<groupId>org.apache.maven.plugins</groupId>
214+
<artifactId>maven-release-plugin</artifactId>
215+
<version>2.5.2</version>
216+
</plugin>
217+
<plugin>
218+
<groupId>org.apache.maven.plugins</groupId>
219+
<artifactId>maven-deploy-plugin</artifactId>
220+
<version>2.8.2</version>
221+
</plugin>
222+
<plugin>
223+
<groupId>org.apache.maven.plugins</groupId>
224+
<artifactId>maven-surefire-plugin</artifactId>
225+
<version>2.19.1</version>
226+
</plugin>
227+
<plugin>
228+
<groupId>org.apache.maven.plugins</groupId>
229+
<artifactId>maven-site-plugin</artifactId>
230+
<version>3.3</version>
231+
</plugin>
232+
</plugins>
233+
</pluginManagement>
214234
</build>
215235
</project>

‎site/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Reference documentation site
2+
3+
This module builds references documentation.
4+
5+
## Building
6+
7+
* Install [Jekyll](http://jekyllrb.com)
8+
* In project root directory do:
9+
* Run `mvn clean`
10+
* Run `mvn compile`
11+
* Run `mvn site`
12+
* The result is in `target/_site`
13+
* Upload it to github pages (`gh-pages` branch)

0 commit comments

Comments
 (0)