Skip to content

Commit 4e58e11

Browse files
committed
Initial docs
1 parent bde142f commit 4e58e11

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
Libtask = "6f1fad26-d15e-5dc8-ae53-837a1d7b8c9f"

docs/make.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
using Documenter, Libtask
2+
3+
makedocs(sitename="Libtask")

docs/src/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Libtask
2+
3+
Libtask is best explained by the docstring for [`TapedTask`](@ref):
4+
```@docs; canonical=true
5+
Libtask.TapedTask
6+
```
7+
8+
The functions discussed the above docstring (in addition to [`TapedTask`](@ref) itself) form the
9+
public interface of Libtask.jl.
10+
They divide neatly into two kinds of functions: those which are used to construct and
11+
manipulate [`TapedTask`](@ref)s, and those which are intended to be used _inside_ a
12+
[`TapedTask`](@ref).
13+
14+
First, manipulation of [`TapedTask`](@ref)s:
15+
```@docs; canonical=true
16+
Libtask.consume
17+
Base.copy(::Libtask.TapedTask)
18+
Libtask.set_dynamic_scope!
19+
```
20+
21+
The functions which enable special functionality inside a [`TapedTask`](@ref)s are:
22+
```@docs; canonical=true
23+
Libtask.produce
24+
Libtask.get_dynamic_scope
25+
```

0 commit comments

Comments
 (0)