setup the framework

Author: GiggleLiu

.gitignore

@@ -3,5 +3,6 @@ Manifest.toml
 *.jl.cov
 *.jl.mem
 /docs/build/
+/docs/src/generated/
 .vscode/
 Session.vim

README.md

@@ -30,8 +30,8 @@ pkg> add TensorInference
 To update, just type `up` in the package mode.
 
 ## Examples
-Examples are in the [example](example) folder, which contains the following list of example problems
-- [asia network](example/asia)
+Examples are in the [examples](examples) folder, which contains the following list of example problems
+- [asia network](examples/asia)
 
 
 ## Supporting and Citing

docs/Project.toml

@@ -1,4 +1,5 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 TensorInference = "c2297e78-99bd-40ad-871d-f50e56b81012"

docs/make.jl

@@ -1,14 +1,17 @@
 using TensorInference
-using TensorInference: OMEinsum, OMEinsumContractionOrders
+using TensorInference: OMEinsum
+using TensorInference.OMEinsum: OMEinsumContractionOrders
 using Documenter, Literate
 
 # Literate
-for each in readdir(pkgdir(TensorInference, "examples"))
-    input_file = pkgdir(TensorInference, "examples", each)
-    endswith(input_file, ".jl") || continue
+const EXAMPLE_DIR = pkgdir(TensorInference, "examples")
+const LITERATE_GENERATED_DIR = pkgdir(TensorInference, "docs", "src", "generated")
+for each in readdir(EXAMPLE_DIR)
+    workdir = joinpath(LITERATE_GENERATED_DIR, each)
+    cp(joinpath(EXAMPLE_DIR, each), workdir; force=true)
+    input_file = joinpath(workdir, "main.jl")
     @info "building" input_file
-    output_dir = pkgdir(TensorInference, "docs", "src", "generated")
-    Literate.markdown(input_file, output_dir; name=each[1:end-3], execute=false)
+    Literate.markdown(input_file, workdir; execute=true)
 end
 
 DocMeta.setdocmeta!(TensorInference, :DocTestSetup, :(using TensorInference); recursive=true)
@@ -27,7 +30,7 @@ makedocs(;
     pages=[
         "Home" => "index.md",
         "Examples" => [
-            "Asia network" => "generated/asia.md",
+            "Asia network" => "generated/asia/main.md",
            ],
         "Performance Tips" => "performance.md",
         "References" => "ref.md",

docs/serve.jl

@@ -0,0 +1,35 @@
+function serve(;host::String="0.0.0.0", port::Int=8000)
+    # setup environment
+    docs_dir = @__DIR__
+    julia_cmd = "using Pkg; Pkg.instantiate()"
+    run(`$(Base.julia_exename()) --project=$docs_dir -e $julia_cmd`)
+
+    serve_cmd = """
+    using LiveServer;
+    LiveServer.servedocs(;
+        doc_env=false,
+        skip_dirs=[
+            joinpath("docs", "src", "generated"),
+            joinpath("docs", "build"),
+        ],
+        skip_files=[
+            joinpath("docs", "Manifest.toml"),
+        ],
+        literate="examples",
+        host=\"$host\",
+        port=$port,
+    )
+    """
+    try
+        run(`$(Base.julia_exename()) --project=$docs_dir -e $serve_cmd`)
+    catch e
+        if e isa InterruptException
+            return
+        else
+            rethrow(e)
+        end
+    end
+    return
+end
+
+serve()

docs/src/index.md

@@ -4,11 +4,4 @@ CurrentModule = TensorInference
 
 # TensorInference
 
-Documentation for [TensorInference](https://github.com/TensorBFS/TensorInference.jl).
-
-```@index
-```
-
-```@autodocs
-Modules = [TensorInference]
-```
+Documentation for [TensorInference](https://github.com/TensorBFS/TensorInference.jl).

docs/src/performance.md

@@ -3,8 +3,9 @@
 
 Let us use the independent set problem on 3-regular graphs as an example.
 ```julia
-julia> using TensorInferece, Artifacts
+julia> using TensorInference, Artifacts, Pkg
 
+julia> Pkg.ensure_artifact_installed("uai2014", pkgdir(TensorInference, "test", "Artifacts.toml"));
 
 julia> function get_instance_filepaths(problem_name::AbstractString, task::AbstractString)
         model_filepath = joinpath(artifact"uai2014", task, problem_name * ".uai")

docs/src/ref.md

@@ -4,16 +4,12 @@
 ```@autodocs
 Modules = [TensorInference]
 Order   = [:function, :type]
+Private = false
 ```
 
 ## Tensor Network
 ```@docs
-optimize_code
-getixsv
-getiyv
 contraction_complexity
-estimate_memory
-@ein_str
 GreedyMethod
 TreeSA
 SABipartite