Skip to content

Commit 5560133

Browse files
committed
Update documentation
1 parent 112ed1b commit 5560133

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ makedocs(;
1414
),
1515
pages=[
1616
"Home" => "index.md",
17+
"API" => "api.md",
1718
],
1819
)
1920

docs/src/api.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# API
2+
3+
## `rearrange`
4+
5+
```@docs
6+
rearrange
7+
```
8+
9+
## `pack` and `unpack`
10+
11+
```@docs
12+
pack
13+
unpack
14+
```
15+
16+
## `@einops_str`
17+
18+
```@docs
19+
@einops_str
20+
```

docs/src/index.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,18 @@ CurrentModule = Einops
66

77
Documentation for [Einops](https://github.com/MurrellGroup/Einops.jl).
88

9-
```@index
9+
## Installation
10+
11+
```julia
12+
using Pkg
13+
pkg"add Einops"
1014
```
1115

12-
```@autodocs
13-
Modules = [Einops]
16+
## Contents
17+
18+
```@contents
19+
Pages = [
20+
"index.md",
21+
"api.md"
22+
]
1423
```

0 commit comments

Comments
 (0)