diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 000000000..dfa65cd10 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,2 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 000000000..a5df4a673 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,16 @@ +using Documenter +using AdvancedVI + +# Doctest setup +DocMeta.setdocmeta!(AdvancedVI, :DocTestSetup, :(using AdvancedVI); recursive=true) + +makedocs(; + sitename="AdvancedVI", + pages=[ + "Home" => "index.md", + "API" => "api.md", + ], + doctest=false, +) + +deploydocs(; repo="github.com/TuringLang/AdvancedVI.jl.git", push_preview=true) diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 000000000..b34e8c9b2 --- /dev/null +++ b/docs/src/api.md @@ -0,0 +1,6 @@ +## API + +```@docs +vi +ADVI +``` diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 000000000..9592c5638 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,5 @@ +# AdvancedVI + +[AdvancedVI](https://github.com/TuringLang/AdvancedVI.jl) provides implementations of variational Bayesian inference (VI) algorithms. +VI algorithms perform scalable and computationally efficient Bayesian inference at the cost of asymptotic exactness. +`AdvancedVI` is part of the [Turing](https://turinglang.org/) probabilistic programming ecosystem.