Skip to content

Commit

Permalink
Add some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jipolanco committed Jan 4, 2024
1 parent 69cb39b commit 2837831
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ makedocs(;
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true",
),
modules = [NonuniformFFTs],
pages = [
"index.md",
"API.md",
],
warnonly = [:missing_docs], # TODO fix this?
)

deploydocs(
Expand Down
27 changes: 27 additions & 0 deletions docs/src/API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# API

```@meta
CurrentModule = NonuniformFFTs
```

## Creating plans

```@docs
PlanNUFFT
```

## Setting non-uniform points

## Executing plans

## Other functions

```@docs
size(::PlanNUFFT)
```

## Index

```@index
Pages = ["NUFFT.md"]
```

0 comments on commit 2837831

Please sign in to comment.