Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmeziere committed Aug 19, 2024
1 parent 57eba38 commit 0edd629
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ using BcdiTrad
makedocs(
sitename="BcdiTrad.jl",
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true"
prettyurls = true
),
pages = [
"BcdiTrad"=>"index.md",
"Usage"=>"use.md"
]
],
)

deploydocs(
Expand Down
14 changes: 5 additions & 9 deletions docs/src/use.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,10 @@ This short script applies 20 HIO iterations and one ER iterations for a total of

# API

```@meta
CurrentModule = BcdiTrad
```

```@docs
BcdiTrad.State(intensities, recSupport)
BcdiTrad.ER()
BcdiTrad.HIO(beta)
BcdiTrad.Shrink(threshold, sigma, state)
BcdiTrad.Center(state)
BcdiTrad.State
BcdiTrad.ER
BcdiTrad.HIO
BcdiTrad.Shrink
BcdiTrad.Center
```

0 comments on commit 0edd629

Please sign in to comment.