Skip to content

Commit b565441

Browse files
committed
Documentation generator.
1 parent f0a9166 commit b565441

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55

66
tests:
7-
julia --project=@. test/runtests.jl
7+
julia --color=yes --project=@. test/runtests.jl
88

99
documentation:
10-
julia --project=@. docs/make.jl
10+
julia --color=yes --project=@. docs/make.jl

docs/make.jl

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

docs/src/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
# ChristensenSet.jl Documentation
3+
4+
```@contents
5+
```
6+
7+
## Polynomial iterator
8+
9+
```@docs
10+
PolynomialIterator
11+
```
12+
13+
## Roots image
14+
15+
```@docs
16+
RootsImage
17+
```
18+
19+
## Computing roots
20+
21+
```@docs
22+
find_roots!
23+
```
24+
25+
## Ploting
26+
27+
```@docs
28+
save_image
29+
fill_image!
30+
fill_images!
31+
plot
32+
```
33+
34+
## Index
35+
36+
```@index
37+
```

0 commit comments

Comments
 (0)