Merge pull request #5 from JuliaRobotics/poc/distributedfactorgraphs

Proof of concept for API and Graphs.jl implementation

Author: GearsAD

.gitignore

@@ -2,3 +2,4 @@
 *.jl.*.cov
 *.jl.mem
 deps/deps.jl
+docs/build

.travis.yml

@@ -2,7 +2,7 @@ language: julia
 os:
     - linux
 julia:
-    - 0.6
+    - 1.0
     - nightly
 notifications:
     email: false
@@ -11,6 +11,6 @@ matrix:
     - julia: nightly
 script:
   - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-  - julia --check-bounds=yes -e 'Pkg.clone(pwd()); Pkg.build("DistributedFactorGraphs"); Pkg.test("DistributedFactorGraphs"; coverage=true)'
+  - julia --check-bounds=yes -e 'using Pkg; Pkg.clone(pwd()); Pkg.build("DistributedFactorGraphs"); Pkg.test("DistributedFactorGraphs"; coverage=true)'
 after_success:
-    - julia -e 'cd(Pkg.dir("DistributedFactorGraphs")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder()); Codecov.submit(process_folder())'
+    - julia -e 'using Pkg; cd(Pkg.dir("DistributedFactorGraphs")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder()); Codecov.submit(process_folder())'

REQUIRE

@@ -1,3 +1,7 @@
-julia 0.6
-Graphs 0.9.0
+julia 1.0
 DocStringExtensions 0.4.1
+# LightGraphs 1.2.0
+# MetaGraphs 0.6.1
+Requires 0.5.2
+JSON2
+Graphs

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"
+)

docs/src/apis/graphs.md

@@ -0,0 +1 @@
+# The Graphs.jl DistributedFactorGraph API

docs/src/example.md

@@ -0,0 +1 @@
+# Example

docs/src/func_ref.md

@@ -0,0 +1,64 @@
+## 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
+hasOrphans
+```
+
+### Copying Subgraphs
+```@docs
+getSubgraphAroundNode
+getSubgraph
+```
+
+### DataFrame Extension Functions
+```@docs
+getAdjacencyMatrixDataFrame
+```

docs/src/getting_started.md

@@ -0,0 +1 @@
+# Getting Started

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"
+]
+```

docs/src/ref_api.md

@@ -0,0 +1 @@
+# Common API Interface