Skip to content

More documentation #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 24 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
bfbc6ae
adding kdocs
Jolanrensen Feb 15, 2022
ced2ef8
more docs
Jolanrensen Feb 15, 2022
9de5ae7
more docs
Jolanrensen Feb 15, 2022
15d41b0
more docs and deprecated downcast()
Jolanrensen Feb 15, 2022
195da8d
2 todo's left, the rest of ApiV1.kt is now kdocced
Jolanrensen Feb 15, 2022
0b6c10c
1 todo left, lit()
Jolanrensen Feb 15, 2022
6ed3424
changed default master value to first check the system variables. Upd…
Jolanrensen Feb 16, 2022
a298239
last doc done
Jolanrensen Feb 16, 2022
e81292e
updated badge to official
Jolanrensen Feb 15, 2022
9c1addc
updated badge to official
Jolanrensen Feb 15, 2022
238d6e8
changed default master value to first check the system variables. Upd…
Jolanrensen Feb 16, 2022
bfbadfe
Merge remote-tracking branch 'Jolanrensen/defaultSparkMasterValue' in…
Jolanrensen Feb 17, 2022
bd854da
Merge pull request #127 from Jolanrensen/defaultSparkMasterValue
Jolanrensen Feb 17, 2022
ca37bc5
adding kdocs
Jolanrensen Feb 15, 2022
7e622ec
more docs
Jolanrensen Feb 15, 2022
d97c654
more docs
Jolanrensen Feb 15, 2022
9b3239b
more docs and deprecated downcast()
Jolanrensen Feb 15, 2022
a81a75b
2 todo's left, the rest of ApiV1.kt is now kdocced
Jolanrensen Feb 15, 2022
f813423
1 todo left, lit()
Jolanrensen Feb 15, 2022
75db05d
last doc done
Jolanrensen Feb 16, 2022
31dd3d3
Merge remote-tracking branch 'Jolanrensen/more-documentation' into mo…
Jolanrensen Feb 17, 2022
0cc61c0
added docs for iterators
Jolanrensen Feb 17, 2022
a9db561
attempting to create github action to generate dokka docs
Jolanrensen Feb 17, 2022
015411f
merging common into the api so the docs are merged
Jolanrensen Feb 17, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/generate_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Generate and publish docs

on:
push:
branches:
- "spark-3.2"
pull_request:
branches:
- "spark-3.2"

jobs:
generate-and-publish-docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
distributions: adopt
java-version: 11
check-latest: true
- name: Generate docs
run: ./mvnw clean package site -Dmaven.test.skip=true
# TODO create branch and copy the docs over from kotlin-spark-api/3.2/target/dokka
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kotlin for Apache® Spark™ [![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx.spark/kotlin-spark-api-parent.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:org.jetbrains.kotlinx.spark%20AND%20v:1.0.2) [![official JetBrains project](http://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
# Kotlin for Apache® Spark™ [![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx.spark/kotlin-spark-api-parent.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:org.jetbrains.kotlinx.spark%20AND%20v:1.0.2) [![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)


Your next API to work with [Apache Spark](https://spark.apache.org/).
Expand Down
5 changes: 1 addition & 4 deletions kotlin-spark-api/3.2/pom_2.12.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@
<groupId>org.jetbrains.kotlinx.spark</groupId>
<artifactId>core-3.2_${scala.compat.version}</artifactId>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlinx.spark</groupId>
<artifactId>kotlin-spark-api-common</artifactId>
</dependency>


<!-- Provided dependencies -->
<dependency>
Expand Down
Loading