Skip to content

Commit ba40950

Browse files
committed
Describe ipynb -> doc
1 parent 529e38b commit ba40950

File tree

2 files changed

+24
-10
lines changed

2 files changed

+24
-10
lines changed

examples/README.adoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

examples/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Examples
2+
3+
This folder contains example notebooks on how to use the `graphdatascience` python client.
4+
5+
6+
## Custom cell tags for notebooks
7+
8+
*Preserve cell outputs*
9+
10+
By default, `makestyle` will remove all cell outputs. If you want to preserve some outputs, tag the cell with `preserve-output`.
11+
12+
13+
## Update /tutorials in docs
14+
15+
Every notebook is also available as `adoc` version living under `doc/pages/tutorials/`.
16+
The latest published version can be viewed at https://neo4j.com/docs/graph-data-science-client/current/.
17+
18+
To update the adoc version, run
19+
20+
```bash
21+
./scripts/nb2doc/convert.sh
22+
```
23+
24+
On how to render the docs locally, the doc [README](../doc/README)

0 commit comments

Comments
 (0)