File tree 1 file changed +15
-0
lines changed
1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Examples
2
+
3
+ This folder contains example notebooks on how to use the `graphdatascience` python client.
4
+
5
+
6
+ ## Custom tooling for notebooks
7
+
8
+ As for the rest of this repository, you can run `../scripts/makestyle` and `../scripts/checkstyle` to apply and check the style of the notebook.
9
+ By default, `makestyle` will remove all cell outputs. If you want to preserve some outputs, tag the cell with `preserve-output` .
10
+
11
+ To generate documenatation, you can run `../scripts/nb2doc/convert` .
12
+
13
+ If you only want to let CI run the notebook given a certain condition, tag a given cell in the notebook with `verify-version` .
14
+ As the name suggests, the tag was introduced to only run for given GDS server versions.
15
+ To make sure certain cells are run even in case of failure, tag the cell with `teardown` .
You can’t perform that action at this time.
0 commit comments