Skip to content

Commit

Permalink
Add minimal documentation for v0.2 (#105)
Browse files Browse the repository at this point in the history
* Add barebones documentation

* Don't check exports
  • Loading branch information
penelopeysm authored Oct 4, 2024
1 parent e4c4c21 commit e79e370
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
16 changes: 16 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -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)
6 changes: 6 additions & 0 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## API

```@docs
vi
ADVI
```
5 changes: 5 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit e79e370

Please sign in to comment.