Skip to content

Commit 0cdedbc

Browse files
committed
Document plugin v2 endpoints in api ref
also improve folder structure
1 parent bab582b commit 0cdedbc

File tree

14 files changed

+45
-20
lines changed

14 files changed

+45
-20
lines changed

doc/sphinx/create_algorithms_rst.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
root_dir = Path(__file__).parent
66

77

8-
with open(root_dir / "algorithms.json") as f, open(root_dir / "source/algorithms.rst", "w") as fw:
8+
with open(root_dir / "algorithms.json") as f, open(root_dir / "source" / "plugin" / "algorithms.rst", "w") as fw:
99
functions = json.load(f)
1010

1111
fw.write(

doc/sphinx/source/index.rst

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,11 @@ This API reference manual lists all available endpoints in the Neo4j Graph Data
1212
:maxdepth: 1
1313
:caption: Contents
1414

15-
graphdatascience
16-
graph
15+
plugin/index
1716
graph_object
1817
graph_create_result
19-
algorithms
20-
ml
21-
pipeline/link-prediction
22-
pipeline/node-classification
23-
pipeline/node-regression
24-
pipeline/node_property_step
25-
pipeline/link_feature
26-
model
27-
model/link-prediction-model
28-
model/node-classification-model
29-
model/node-regression-model
30-
model/graphsage-model
31-
model/simple_rel_embedding_model
32-
misc
18+
pipeline/index
19+
model/index
3320
server_version
3421
sessions/index
3522
v2_endpoints/index

doc/sphinx/source/model/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. toctree::
2+
:maxdepth: 1
3+
:caption: Contents
4+
5+
link-prediction-model
6+
node-classification-model
7+
node-regression-model
8+
graphsage-model
9+
simple_rel_embedding_model
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. toctree::
2+
:maxdepth: 1
3+
:caption: Contents
4+
5+
link-prediction
6+
node-classification
7+
node-regression
8+
node_property_step
9+
link_feature
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/sphinx/source/plugin/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. toctree::
2+
:maxdepth: 1
3+
:caption: Contents
4+
5+
graphdatascience
6+
graph
7+
algorithms
8+
ml
9+
model
10+
misc
11+
12+
.. toctree::
13+
:hidden:
14+
15+
plugin_v2_endpoints
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)