Documentation structure and function reference list

GearsAD · GearsAD · commit 46051123601f · 2019-04-17T15:09:56.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 *.jl.*.cov
 *.jl.mem
 deps/deps.jl
+docs/build
diff --git a/REQUIRE b/REQUIRE
@@ -3,6 +3,5 @@ DocStringExtensions 0.4.1
 # LightGraphs 1.2.0
 # MetaGraphs 0.6.1
 Requires 0.5.2
-DataFrames
 JSON2
 Graphs
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,35 @@
+using Documenter
+using DataFrames
+using DistributedFactorGraphs, DistributedFactorGraphs.GraphsJl
+
+makedocs(
+    modules = [DistributedFactorGraphs, DistributedFactorGraphs.GraphsJl],
+    format = Documenter.HTML(),
+    sitename = "DistributedFactorGraphs.jl",
+    pages = Any[
+        "Home" => "index.md",
+        "Getting Started" => [
+            "Introduction" => "getting_started.md",
+            "Variables and Factors" => "variables_and_factors.md",
+            "Common API Interface" => "ref_api.md",
+            "Example" => "example.md"
+        ],
+        "DistributedFactorGraph API's" => [
+            "Graphs.jl" => "apis/graphs.md",
+            "MetaGraph.jl" => "apis/graphs.md",
+            "GraffSDK.jl" => "apis/graphs.md",
+            "CloudGraphs.jl" => "apis/graphs.md",
+        ],
+        "Reference" => "func_ref.md"
+    ]
+    # html_prettyurls = !("local" in ARGS),
+    )
+
+deploydocs(
+    repo   = "github.com/JuliaRobotics/DistributedFactorGraphs.jl.git",
+    target = "build",
+    deps   = Deps.pip("mkdocs", "python-markdown-math"),
+    make   = nothing,
+    julia  = "1.0",
+    osname = "linux"
+)
diff --git a/docs/src/apis/graphs.md b/docs/src/apis/graphs.md
@@ -0,0 +1 @@
+# The Graphs.jl DistributedFactorGraph API
diff --git a/docs/src/example.md b/docs/src/example.md
@@ -0,0 +1 @@
+# Example
diff --git a/docs/src/func_ref.md b/docs/src/func_ref.md
@@ -0,0 +1,63 @@
+## Function Reference
+
+```@contents
+Pages = [
+    "func_ref.md"
+]
+Depth = 3
+```
+
+### Graph Types
+```@docs
+GraphsDFG
+```
+
+### Creating DFG Factor Graphs
+```@docs
+addVariable!
+addFactor!
+```
+
+### Getting Factor Graph Nodes
+```@docs
+getVariables
+getFactors
+getVariable
+getFactor
+getNeighbors
+ls
+lsf
+```
+
+### Updating Factor Graph Nodes
+```@docs
+updateVariable!
+updateFactor!
+```
+
+### Deleting Factor Graph Nodes
+```@docs
+deleteVariable!
+deleteFactor!
+```
+
+### Getting Adjacency Matrix
+```@docs
+getAdjacencyMatrix
+```
+
+### Validating Factor Graph Connectivity
+```@docs
+isFullyConnected
+```
+
+### Copying Subgraphs
+```@docs
+getSubgraphAroundNode
+getSubgraph
+```
+
+### DataFrame Extension Functions
+```@docs
+getAdjacencyMatrixDataFrame
+```
diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md
@@ -0,0 +1 @@
+# Getting Started
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,22 @@
+# GraffSDK.jl Documentation
+
+This package is a Julia SDK for SlamInDb/Graff.
+
+## Installation
+This package is not yet registered with JuliaLang/METADATA.jl, but can be easily installed in Julia 0.6 with:
+```julia
+Pkg.clone("https://github.com/GearsAD/GraffSDK.jl.git")
+Pkg.build("GraffSDK")
+```
+
+## Manual Outline
+```@contents
+Pages = [
+    "index.md"
+    "getting_started.md"
+    "variables_and_factors.md"
+    "ref_api.md"
+    "example.md"
+    "func_ref.md"
+]
+```
diff --git a/docs/src/ref_api.md b/docs/src/ref_api.md
@@ -0,0 +1 @@
+# Common API Interface
diff --git a/docs/src/variables_and_factors.md b/docs/src/variables_and_factors.md
@@ -0,0 +1 @@
+# Variables and Factors
diff --git a/src/DistributedFactorGraphs.jl b/src/DistributedFactorGraphs.jl
@@ -14,19 +14,6 @@ export DFGNode
 export DFGFactor
 export DFGVariable
 
-# Exports for actual graph operations - we need a complete list here
-export addVariable!
-export addFactor!
-export ls, lsf, getVariables, getFactors
-export getVariable, getFactor
-export updateVariable, updateFactor
-export getAdjacencyMatrix
-export getAdjacencyMatrixDataFrame
-export getNeighbors
-export getSubgraphAroundNode
-export getSubgraph
-export isFullyConnected
-
 # Include the Graphs.jl API.
 include("services/GraphsDFG.jl")
 
diff --git a/src/entities/DFGAPI.jl b/src/entities/DFGAPI.jl
@@ -0,0 +1,51 @@
+### Discussion
+# * How can we implement function signatures here?
+# * addV has a few implementations and all can be used by the single reference (nice work Julia!)
+# * Where do we incorporate sessions/robot/user? Can be intrinsically, or in the configuration (children)
+# * The philosophy of dealing atomically with factors and vertices should
+#   simplify things. Creation of a factor or variable should be atomic and in
+#   transaction. This to be discussed.
+
+import Base: show
+
+
+mutable struct LightDFGraph <: DFG
+end
+
+
+# Assuming our base types are variables and factors.
+# May refactor this soon back to vertices and edges, depending on
+# how the experiment goes.
+struct DFGAPI
+    configuration::Any
+    description::String
+    validateConfig::Function
+    # Base functions
+    addV!::Function
+    addF!::Function
+    getV::Function
+    getVs::Function
+    getF::Function
+    getFs::Function
+    updateV!::Function
+    updateF!::Function
+    deleteV!::Function
+    deleteF!::Function
+    getProp::Function
+    setProp!::Function
+    deleteProp!::Function
+    getProps::Function
+    setProps!::Function
+    # Query functions
+    neighbors::Function
+    ls::Function
+    lsf::Function
+    subGraph::Function
+    adjacencyMatrix::Function
+    # Additional parameters for extensibility
+    additionaProperties::Dict{String, Any}
+end
+
+function show(io::IO, d::DFGAPI)
+    println(io, "DFG API: $(d.description)")
+end
diff --git a/src/entities/DFGFactor.jl b/src/entities/DFGFactor.jl
@@ -1,3 +1,7 @@
+"""
+    $(SIGNATURES)
+Fundamental structure for a DFG factor.
+"""
 mutable struct DFGFactor <: DFGNode
     label::Symbol
     #TODO: Populate
diff --git a/src/services/GraphsDFG.jl b/src/services/GraphsDFG.jl
diff --git a/test/runtests.jl b/test/runtests.jl

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# The Graphs.jl DistributedFactorGraph API`