Skip to content

More documentation #128

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

Merged
merged 29 commits into from
Feb 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 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
a298239
last doc done
Jolanrensen Feb 16, 2022
9c1addc
updated badge to official
Jolanrensen Feb 15, 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
301f46d
added copy docs action
Jolanrensen Feb 17, 2022
dca5df8
added copy docs action
Jolanrensen Feb 17, 2022
9055932
alright, let's first test it for this branch. If that works, we can m…
Jolanrensen Feb 17, 2022
adae99f
alright, let's first test it for this branch. If that works, we can m…
Jolanrensen Feb 17, 2022
d4b8b5c
alright, let's first test it for this branch. If that works, we can m…
Jolanrensen Feb 18, 2022
96b43da
alright, let's first test it for this branch. If that works, we can m…
Jolanrensen Feb 18, 2022
883bdc5
alright, let's first test it for this branch. If that works, we can m…
Jolanrensen Feb 18, 2022
82d3940
maybe copycat works better
Jolanrensen Feb 18, 2022
671fc3b
using actions-gh-pages?
Jolanrensen Feb 18, 2022
b5ece11
it's working now!
Jolanrensen Feb 18, 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
33 changes: 33 additions & 0 deletions .github/workflows/generate_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
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
- name: Copy docs to "docs" branch
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: docs
publish_dir: ./kotlin-spark-api/3.2/target/dokka


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