neo4j-contrib · Andy2003 · Mar 30, 2025 · Feb 19, 2025 · Feb 19, 2025 · Feb 20, 2025
diff --git a/docs/docs.yml b/docs/docs.yml
@@ -10,7 +10,12 @@ ui:
   bundle:
     url: https://static-content.neo4j.com/build/ui-bundle.zip
     snapshot: true
+urls:
+  html_extension_style: indexify
+
 asciidoc:
+  extensions:
+    - "@neo4j-documentation/macros"
   attributes:
-    page-theme: docs
+    page-theme: labs
     page-cdn: /_/
diff --git a/docs/docs/modules/ROOT/nav.adoc b/docs/docs/modules/ROOT/nav.adoc
@@ -1,9 +1,13 @@
 * xref:overview/introduction.adoc[]
+* xref:api/index.adoc[]
++
+--
+include::partial$generated/api-nav.adoc[]
+--
 
 * xref::dev/index.adoc[]
 ** xref:dev/indexing.adoc[]
 ** xref:dev/layers.adoc[]
-** xref:dev/procedures.adoc[]
 ** xref:dev/querying.adoc[]
 ** xref:dev/examples.adoc[]
 *** xref:geo-pipes/index.adoc[]

diff --git a/docs/docs/modules/ROOT/pages/api/index.adoc b/docs/docs/modules/ROOT/pages/api/index.adoc
@@ -0,0 +1,8 @@
+[[procedures-and-functions]]
+= Procedures & Functions
+:description: This chapter provides a reference of all the procedures and functions in the spatial library.
+
+Neo4j Spatial is also packaged as a ZIP file that can be unzipped into the http://neo4j.com[Neo4j Server] `$NEO4J_HOME/plugins` directory.
+After restarting the server, you should be able to use the following *procedure* and *function* calls from the Cypher query language.
+
+include::partial$generated/api/index.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial.addNode/spatial.addNode.byId.adoc b/docs/docs/modules/ROOT/pages/api/spatial.addNode/spatial.addNode.byId.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial.addNode/spatial.addNode.byId.adoc[]
+
+// == Examples
+// 
+// include::partial$generated/api/spatial.addNode/spatial.addNode.byId-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial.addNodes/spatial.addNodes.byId.adoc b/docs/docs/modules/ROOT/pages/api/spatial.addNodes/spatial.addNodes.byId.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial.addNodes/spatial.addNodes.byId.adoc[]
+
+// == Examples
+// 
+// include::partial$generated/api/spatial.addNodes/spatial.addNodes.byId-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial.removeNode/spatial.removeNode.byId.adoc b/docs/docs/modules/ROOT/pages/api/spatial.removeNode/spatial.removeNode.byId.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial.removeNode/spatial.removeNode.byId.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial.removeNode/spatial.removeNode.byId-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial.removeNodes/spatial.removeNodes.byId.adoc b/docs/docs/modules/ROOT/pages/api/spatial.removeNodes/spatial.removeNodes.byId.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial.removeNodes/spatial.removeNodes.byId.adoc[]
+
+// == Examples
+// 
+// include::partial$generated/api/spatial.removeNodes/spatial.removeNodes.byId-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addLayerWithEncoder.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addLayerWithEncoder.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addLayerWithEncoder.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addLayerWithEncoder-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNativePointLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNativePointLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerGeohash.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerGeohash.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNativePointLayerGeohash.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNativePointLayerGeohash-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerHilbert.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerHilbert.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNativePointLayerHilbert.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNativePointLayerHilbert-examples.adoc[]
diff --git a/.../docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerWithConfig.adoc b/.../docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerWithConfig.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNativePointLayerWithConfig.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNativePointLayerWithConfig-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerXY.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerXY.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNativePointLayerXY.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNativePointLayerXY-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerZOrder.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerZOrder.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNativePointLayerZOrder.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNativePointLayerZOrder-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNode.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNode.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNode.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNode-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNodes.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addNodes.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addNodes.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addNodes-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addPointLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addPointLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerGeohash.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerGeohash.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addPointLayerGeohash.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addPointLayerGeohash-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerHilbert.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerHilbert.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addPointLayerHilbert.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addPointLayerHilbert-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerWithConfig.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerWithConfig.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addPointLayerWithConfig.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addPointLayerWithConfig-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerXY.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerXY.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addPointLayerXY.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addPointLayerXY-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerZOrder.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerZOrder.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addPointLayerZOrder.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addPointLayerZOrder-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addWKT.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addWKT.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addWKT.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addWKT-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addWKTLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addWKTLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addWKTLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addWKTLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.addWKTs.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.addWKTs.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.addWKTs.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.addWKTs-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.asExternalGeometry.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.asExternalGeometry.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.asExternalGeometry.adoc[]
+
+// == Examples
+// 
+// include::partial$generated/api/spatial/spatial.asExternalGeometry-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.asGeometry.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.asGeometry.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.asGeometry.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.asGeometry-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.asMap.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.asMap.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.asMap.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.asMap-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.bbox.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.bbox.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.bbox.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.bbox-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.closest.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.closest.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.closest.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.closest-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.decodeGeometry.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.decodeGeometry.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.decodeGeometry.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.decodeGeometry-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.getFeatureAttributes.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.getFeatureAttributes.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.getFeatureAttributes.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.getFeatureAttributes-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.importOSM.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.importOSM.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.importOSM.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.importOSM-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.importOSMToLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.importOSMToLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.importOSMToLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.importOSMToLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.importShapefile.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.importShapefile.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.importShapefile.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.importShapefile-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.importShapefileToLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.importShapefileToLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.importShapefileToLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.importShapefileToLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.intersects.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.intersects.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.intersects.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.intersects-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.layer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.layer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.layer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.layer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.layerTypes.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.layerTypes.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.layerTypes.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.layerTypes-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.layers.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.layers.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.layers.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.layers-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.neo4jGeometryToWkt.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.neo4jGeometryToWkt.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.neo4jGeometryToWkt.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.neo4jGeometryToWkt-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.procedures.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.procedures.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.procedures.adoc[]
+
+// == Examples
+// 
+// include::partial$generated/api/spatial/spatial.procedures-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.removeLayer.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.removeLayer.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.removeLayer.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.removeLayer-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.removeNode.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.removeNode.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.removeNode.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.removeNode-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.removeNodes.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.removeNodes.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.removeNodes.adoc[]
+
+// == Examples
+//
+// include::partial$generated/api/spatial/spatial.removeNodes-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.setFeatureAttributes.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.setFeatureAttributes.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.setFeatureAttributes.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.setFeatureAttributes-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.upgrade.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.upgrade.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.upgrade.adoc[]
+
+// == Examples
+// 
+// include::partial$generated/api/spatial/spatial.upgrade-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.withinDistance.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.withinDistance.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.withinDistance.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.withinDistance-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/api/spatial/spatial.wktToGeoJson.adoc b/docs/docs/modules/ROOT/pages/api/spatial/spatial.wktToGeoJson.adoc
@@ -0,0 +1,5 @@
+include::partial$generated/api/spatial/spatial.wktToGeoJson.adoc[]
+
+== Examples
+
+include::partial$generated/api/spatial/spatial.wktToGeoJson-examples.adoc[]
diff --git a/docs/docs/modules/ROOT/pages/dev/index.adoc b/docs/docs/modules/ROOT/pages/dev/index.adoc
@@ -3,7 +3,6 @@
 
 * xref:dev/indexing.adoc[]
 * xref:dev/layers.adoc[]
-* xref:dev/procedures.adoc[]
 * xref:dev/querying.adoc[]
 * xref:dev/examples.adoc[]
 ** xref:geo-pipes/index.adoc[]

diff --git a/docs/docs/modules/ROOT/pages/dev/procedures.adoc b/docs/docs/modules/ROOT/pages/dev/procedures.adoc
diff --git a/docs/docs/modules/ROOT/pages/index.adoc b/docs/docs/modules/ROOT/pages/index.adoc
@@ -4,6 +4,7 @@
 :toclevels: 2
 
 * xref:overview/introduction.adoc[]
+* xref:api/index.adoc[]
 * xref:dev/index.adoc[]
 * xref:appendix/index.adoc[]
 

diff --git a/docs/docs/modules/ROOT/pages/overview/introduction.adoc b/docs/docs/modules/ROOT/pages/overview/introduction.adoc
@@ -21,7 +21,7 @@ The key features include:
 
 The easiest way to get started with neo4j-spatial is to grab the `server-plugin-*.jar` from https://github.com/neo4j-contrib/spatial/releases[the latest release], copy it to your `$NEO4J_HOME/plugins` and restart your Neo4j server.
 
-From there you can use all the xref:dev/procedures.adoc[spatial-procedures] in your Cypher queries to add Nodes to the spatial index and perform a number of spatial point, distance and intersection queries.
+From there you can use all the xref:api/index.adoc[spatial procedures and functions] in your Cypher queries to add Nodes to the spatial index and perform a number of spatial point, distance and intersection queries.
 
 .Simple Example
 [source,cypher]