Skip to content

Commit 204ac2b

Browse files
authored
Merge pull request #155 from JetBrains/dokka-jupyter
added dokka to jupyter module, updated readme
2 parents 5584a3e + bd36681 commit 204ac2b

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@ This does not start a Spark session right away, meaning you can call `withSparkS
103103
in whichever cell you want.
104104
Check out the [example](examples/src/main/kotlin/org/jetbrains/kotlinx/spark/examples/streaming/JupyterStreamingExample.ipynb).
105105

106+
NOTE: You need `kotlin-jupyter-kernel` to be at least version 0.11.0.83 for the Kotlin Spark API to work. Also, if the
107+
`%use spark` magic does not output "Spark session has been started...", and `%use spark-streaming` doesn't work at all,
108+
add `%useLatestDescriptors` above it.
109+
106110
## Kotlin for Apache Spark features
107111

108112
### Creating a SparkSession in Kotlin

jupyter/pom.xml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,30 @@
9898
<testSourceDirectory>src/test/kotlin</testSourceDirectory>
9999
<directory>target/${scala.compat.version}</directory>
100100
<plugins>
101+
<plugin>
102+
<groupId>org.jetbrains.dokka</groupId>
103+
<artifactId>dokka-maven-plugin</artifactId>
104+
<version>${dokka.version}</version>
105+
<configuration>
106+
<jdkVersion>8</jdkVersion>
107+
</configuration>
108+
<executions>
109+
<execution>
110+
<id>dokka</id>
111+
<goals>
112+
<goal>dokka</goal>
113+
</goals>
114+
<phase>pre-site</phase>
115+
</execution>
116+
<execution>
117+
<id>javadocjar</id>
118+
<goals>
119+
<goal>javadocJar</goal>
120+
</goals>
121+
<phase>pre-integration-test</phase>
122+
</execution>
123+
</executions>
124+
</plugin>
101125
<plugin>
102126
<groupId>org.jetbrains.kotlin</groupId>
103127
<artifactId>kotlin-maven-plugin</artifactId>

0 commit comments

Comments
 (0)