Merge pull request #347 from FluxML/doc

Update README and documentation

Author: yuehhua

README.md

@@ -38,7 +38,7 @@ A `FeaturedGraph` can be constructed from various graph structures, including
 adjacency matrices, adjacency lists, Graphs' types...
 
 ```julia
-fg = FeaturedGraph(adj_list)   
+fg = FeaturedGraph(adj_list)
 ```
 
 ### Graph convolutional layers
@@ -75,7 +75,7 @@ Flux.train!(loss, ps, train_data, opt, cb=throttle(evalcb, 10))
 
 To achieve geometric deep learning raised by Bronstein *et al*, 5G fields of deep learning models will be supported in GeometricFlux.jl. For details, you could check the [geometric deep learning official website](https://geometricdeeplearning.com/).
 
-5G including the following fields:
+5(+1)G including the following fields:
 
 * **Graphs** and Sets
   * including classical GNN models and networks over sets.
@@ -87,3 +87,8 @@ To achieve geometric deep learning raised by Bronstein *et al*, 5G fields of dee
   * including a series of equivariant/invariant models.
 * **Geodesics** and Manifolds
 * **Gauges** and Bundles
+* **Geometric algebra**
+
+## Discussions
+
+It's welcome to have direct discussions in #graphnet channel or in #flux-bridged channel on slack. For usage issues, it's welcome to post your minimal working examples (MWE) on [Julia discourse](https://discourse.julialang.org/) and then tag maintainer `@yuehhua`.

docs/Project.toml

@@ -4,6 +4,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
 GeometricFlux = "7e08b658-56d3-11e9-2997-919d5b31e4ea"
+MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"
 
 [compat]
 Documenter = "0.27"

docs/make.jl

@@ -1,18 +1,20 @@
 using Documenter
 using DocumenterCitations
+using MultiDocumenter
 using DemoCards
 using GeometricFlux
 
 const ASSETS = ["assets/flux.css", "assets/favicon.ico"]
 
 bib = CitationBibliography(joinpath(@__DIR__, "bibliography.bib"), sorting=:nyt)
 
-DocMeta.setdocmeta!(GeometricFlux, :DocTestSetup, :(using GeometricFlux, Flux); recursive=true)
+DocMeta.setdocmeta!(GeometricFlux, :DocTestSetup, :(using GeometricFlux, GraphSignals, Flux); recursive=true)
 
 # DemoCards
 demopage, postprocess_cb, demo_assets = makedemos("tutorials")
 isnothing(demo_assets) || (push!(ASSETS, demo_assets))
 
+# build GeometricFlux documentation
 makedocs(
     bib,
     sitename = "GeometricFlux.jl",
@@ -23,7 +25,7 @@ makedocs(
       edit_link = "master",
     ),
     clean = false,
-    modules = [GeometricFlux,GraphSignals],
+    modules = [GeometricFlux, GraphSignals],
     pages = ["Home" => "index.md",
              demopage,
              "Introduction" => "introduction.md",
@@ -59,7 +61,39 @@ makedocs(
 # callbacks of DemoCards
 postprocess_cb()
 
+# build MultiDocumenter
+clonedir = mktempdir()
+
+docs = [
+    ("FluxML/GeometricFlux.jl.git", "gh-pages", false) => MultiDocumenter.MultiDocRef(
+        upstream = joinpath(clonedir, "GeometricFlux"),
+        path = "geometricflux",
+        name = "GeometricFlux"
+    ),
+    ("yuehhua/GraphSignals.jl.git", "gh-pages", false) => MultiDocumenter.MultiDocRef(
+        upstream = joinpath(clonedir, "GraphSignals"),
+        path = "graphsignals",
+        name = "GraphSignals"
+    ),
+]
+
+for ((remote, branch, use_ssh), docref) in docs
+  prefix = use_ssh ? "git@github.com:" : "https://github.com/"
+  run(`git clone --depth 1 $prefix$remote --branch $branch --single-branch $(docref.upstream)`)
+end
+
+outpath = joinpath(@__DIR__, "out")
+
+MultiDocumenter.make(
+  outpath,
+  collect(last.(docs));
+  search_engine = MultiDocumenter.SearchConfig(
+      index_versions = ["stable"],
+      engine = MultiDocumenter.FlexSearch
+  )
+)
+
 deploydocs(
   repo = "github.com/FluxML/GeometricFlux.jl.git",
-  target = "build",
+  target = "out",
 )