Merge pull request #6563 from vnickolov/steiner-docs

Add Steiner tree documentation

Author: vnickolov

doc-test/src/test/java/org/neo4j/gds/doc/SteinerTreeDocTest.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.doc;
+
+import org.neo4j.gds.catalog.GraphProjectProc;
+import org.neo4j.gds.functions.AsNodeFunc;
+import org.neo4j.gds.paths.steiner.SteinerTreeMutateProc;
+import org.neo4j.gds.paths.steiner.SteinerTreeStatsProc;
+import org.neo4j.gds.paths.steiner.SteinerTreeStreamProc;
+import org.neo4j.gds.paths.steiner.SteinerTreeWriteProc;
+
+import java.util.List;
+
+class SteinerTreeDocTest extends SingleFileDocTestBase {
+
+    @Override
+    protected List<Class<?>> functions() {
+        return List.of(AsNodeFunc.class);
+    }
+
+    @Override
+    protected List<Class<?>> procedures() {
+        return List.of(
+            SteinerTreeStatsProc.class,
+            SteinerTreeStreamProc.class,
+            SteinerTreeWriteProc.class,
+            SteinerTreeMutateProc.class,
+            GraphProjectProc.class
+        );
+    }
+
+    @Override
+    protected String adocFile() {
+        return "pages/algorithms/directed-steiner-tree.adoc";
+    }
+
+}

doc-test/src/test/java/org/neo4j/gds/doc/syntax/SteinerTreeSyntaxTest.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.doc.syntax;
+
+import java.util.List;
+
+class SteinerTreeSyntaxTest extends SyntaxTestBase {
+
+    @Override
+    protected Iterable<SyntaxModeMeta> syntaxModes() {
+        return List.of(
+            SyntaxModeMeta.of(SyntaxMode.STREAM),
+            SyntaxModeMeta.of(SyntaxMode.STATS),
+            SyntaxModeMeta.of(SyntaxMode.WRITE),
+            SyntaxModeMeta.of(SyntaxMode.MUTATE)
+        );
+    }
+
+    @Override
+    protected String adocFile() {
+        return "pages/algorithms/directed-steiner-tree.adoc";
+    }
+}

doc/modules/ROOT/content-nav.adoc

@@ -82,6 +82,7 @@
 *** xref:algorithms/yens.adoc[]
 *** xref:algorithms/minimum-weight-spanning-tree.adoc[]
 *** xref:alpha-algorithms/k-minimum-weight-spanning-tree.adoc[]
+*** xref:algorithms/directed-steiner-tree.adoc[]
 *** xref:alpha-algorithms/all-pairs-shortest-path.adoc[]
 *** xref:algorithms/random-walk.adoc[]
 *** xref:algorithms/bfs.adoc[]