Skip to content

Commit 4cfa0ce

Browse files
committed
README.md updates related to jupyter
1 parent 0b5744f commit 4cfa0ce

File tree

3 files changed

+26
-8
lines changed

3 files changed

+26
-8
lines changed

core/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@ or [:dataframe-jdbc](../dataframe-jdbc), however, this is has not happened yet f
99

1010
At the moment, these integrations are still part of the `:core` module:
1111

12-
- csv/tsv
12+
- (deprecated) csv/tsv
1313
- html
1414
- json
15-
- jupyter
1615

1716
### Korro code samples
1817

@@ -36,10 +35,10 @@ We can also generate "normal" DataFrame samples for the website. This can be don
3635
[OtherSamples class](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt). Generated
3736
HTML files will be stored in [docs/StardustDocs/snippets/manual](../docs/StardustDocs/snippets/manual).
3837

39-
### KDoc Preprocesor
38+
### KoDEx
4039

41-
The code you're working on needs to be edited in [src](src), but the KDocs are processed by the
42-
[KDoc Preprocessor](https://github.com/Jolanrensen/docProcessorGradlePlugin) when the project is published (or the task
40+
The code you're working on needs to be edited in [src](src), but the KDocs are processed by
41+
[KoDEx](https://github.com/Jolanrensen/kodex) when the project is published (or the task
4342
is run manually). The generated sources with adjusted KDocs will be overwritten
4443
in [generated-sources](generated-sources).
4544
See the [KDoc Preprocessing Guide](../KDOC_PREPROCESSING.md) for more information.

dataframe-jupyter/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## :dataframe-jupyter
2+
3+
This module, published as `dataframe-jupyter`, contains all logic and tests for DataFrame to be able to work
4+
in [Jupyter notebooks](https://kotlin.github.io/dataframe/gettingstartedjupyternotebook.html)
5+
and the [Kotlin Notebook IntelliJ Plugin](https://kotlin.github.io/dataframe/usage-with-kotlin-notebook-plugin.html).
6+
7+
The main integration point is at [Integration.kt](src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/Integration.kt).
8+
This is what will be called when people write `%use dataframe` thanks to our
9+
[Kotlin Notebook library descriptor](https://github.com/Kotlin/kotlin-jupyter-libraries/blob/master/dataframe.json).
10+
11+
This module is a friend module of [`:core`](../core) to be able to access internal APIs.
12+
13+
See [Get started with Kotlin DataFrame on Jupyter Notebook](https://kotlin.github.io/dataframe/gettingstartedjupyternotebook.html),
14+
and [Usage with Kotlin Notebook Plugin](https://kotlin.github.io/dataframe/usage-with-kotlin-notebook-plugin.html).
15+

examples/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,11 @@ ___
4545
* imdb sql database ([notebook](https://github.com/zaleslaw/KotlinDataFrame-SQL-Examples/blob/master/notebooks/imdb.ipynb)) – In this notebook, we use Kotlin DataFrame and Kandy library to analyze data from [IMDB](https://datasets.imdbws.com/) (SQL dump for the MariaDB database with the name "imdb" could be downloaded by this [link](https://drive.google.com/file/d/10HnOu0Yem2Tkz_34SfvDoHTVqF_8b4N7/view?usp=sharing)).
4646

4747
---
48-
* 0.14 Feature Overview [notebook](notebooks/feature_overviews/0.14/new_features.ipynb)
49-
Overview of new features available in 0.14
48+
* Feature Overviews [notebook folder](notebooks/feature_overviews)
49+
Overview of new features available a given version
5050

51-
These example notebooks are tested by the [:core module](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/jupyter).
51+
The example notebooks always target the latest stable version of the library.
52+
Notebooks compatible with the latest dev/master version are located in the [dev](notebooks/dev) folder.
53+
54+
These [dev versions](notebooks/dev) are tested by the
55+
[:dataframe-jupyter module](../dataframe-jupyter/src/test/kotlin/org/jetbrains/kotlinx/dataframe/jupyter).

0 commit comments

Comments
 (0)