Merge pull request #26 from AlgebraicJulia/fix_docs

removed nested uwds from docs
AlgebraicJulia · Nov 20, 2024 · 2549aa4 · 2549aa4
2 parents 70c5f1f + 3434467
commit 2549aa4
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -1,5 +1,5 @@
 # Library Reference
 
 ```@autodocs
-Modules = [StructuredDecompositions, StructuredDecompositions.Decompositions, StructuredDecompositions.FunctorUtils, StructuredDecompositions.DecidingSheaves, StructuredDecompositions.JunctionTrees, StructuredDecompositions.NestedUWDs]
+Modules = [StructuredDecompositions, StructuredDecompositions.Decompositions, StructuredDecompositions.FunctorUtils, StructuredDecompositions.DecidingSheaves, StructuredDecompositions.JunctionTrees]
 ```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -19,7 +19,6 @@ Pages = [
     "pages/decompostions.md",
     "pages/decidingsheaves.md",
     "pages/junction_trees.md",
-    "pages/nested_uwds.md",
     "pages/functor_utils.md",
     ]
 Depth = 2

diff --git a/docs/src/pages/nested_uwds.md b/docs/src/pages/nested_uwds.md
diff --git a/src/junction_trees/supernode_types.jl b/src/junction_trees/supernode_types.jl
@@ -3,8 +3,8 @@
 
 A type of supernode. The options are
 - [`Node`](@ref)
-- [`MaximalSupernode`](@ref)
-- [`FundamentalSupernode`](@ref)
+- [`Maximal](@ref)
+- [`Fundamental`](@ref)
 """
 abstract type SupernodeType end
 
@@ -18,15 +18,15 @@ struct Node <: SupernodeType end
 
 
 """
-    MaximalSupernode <: Supernode
+    Maximal <: Supernode
 
 A maximal supernode.
 """
 struct Maximal <: SupernodeType end
 
 
 """
-    FundamentalSupernode <: Supernode
+    Fundamental <: Supernode
 
 A fundamental supernode.
 """