Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
devmotion authored and oschulz committed Oct 11, 2021
1 parent a40c765 commit 154a013
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 28 deletions.
31 changes: 3 additions & 28 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,7 @@
# API

```@meta
DocTestSetup = quote
using ChangesOfVariables
end
```

## Modules

```@index
Order = [:module]
```

## Types and constants

```@index
Order = [:type, :constant]
```

## Functions and macros

```@index
Order = [:macro, :function]
```

# Documentation
## Interface

```@autodocs
Modules = [ChangesOfVariables]
Order = [:module, :type, :constant, :macro, :function]
```@docs
with_logabsdet_jacobian
```
4 changes: 4 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ChangesOfVariables.jl

```@docs
ChangesOfVariables
```

This package defines the function [`with_logabsdet_jacobian`](@ref). `(y, ladj) = with_logabsdet_jacobian(f, x)` computes both the transformed value of `x` under the transformation `f` and the logarithm of the [volume element](https://en.wikipedia.org/wiki/Volume_element).

`with_logabsdet_jacobian` supports mapped/broadcasted functions (via `Base.Fix1`) and (on Julia >=v1.6) function composition.
Expand Down

0 comments on commit 154a013

Please sign in to comment.