From e7dc2a047d00e3bd1a6a67261e6ceee9caadacac Mon Sep 17 00:00:00 2001 From: Penelope Yong Date: Fri, 4 Oct 2024 19:08:52 +0100 Subject: [PATCH 1/2] Add barebones documentation --- docs/Project.toml | 2 ++ docs/make.jl | 18 ++++++++++++++++++ docs/src/api.md | 6 ++++++ docs/src/index.md | 5 +++++ 4 files changed, 31 insertions(+) create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/api.md create mode 100644 docs/src/index.md 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..31d70356b --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,18 @@ +using Documenter +using AdvancedVI + +# Doctest setup +DocMeta.setdocmeta!(AdvancedVI, :DocTestSetup, :(using AdvancedVI); recursive=true) + +makedocs(; + sitename="AdvancedVI", + modules=[AdvancedVI], + pages=[ + "Home" => "index.md", + "API" => "api.md", + ], + checkdocs=:exports, + 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. From c3e4aef873f79ca1be0db59543c7ef3a979a6bf8 Mon Sep 17 00:00:00 2001 From: Penelope Yong Date: Fri, 4 Oct 2024 19:24:01 +0100 Subject: [PATCH 2/2] Don't check exports --- docs/make.jl | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 31d70356b..a5df4a673 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -6,12 +6,10 @@ DocMeta.setdocmeta!(AdvancedVI, :DocTestSetup, :(using AdvancedVI); recursive=tr makedocs(; sitename="AdvancedVI", - modules=[AdvancedVI], pages=[ "Home" => "index.md", "API" => "api.md", ], - checkdocs=:exports, doctest=false, )