Skip to content

Commit 392fe35

Browse files
authored
Reorganize documentation (#256)
Splits the mathematical description out from the code help. Closes #153
1 parent b830efe commit 392fe35

31 files changed

+2533
-1772
lines changed

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ docs/src/democards
88
Manifest.toml
99
/.benchmarkci
1010
/benchmark/*.json
11+
.DS_Store

Diff for: docs/make.jl

+18-7
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,31 @@ format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true",
1414
assets = assets)
1515

1616
makedocs(
17-
modules = [ImageFiltering, OffsetArrays, Kernel, KernelFactors, ImageFiltering.MapWindow],
18-
format = format,
19-
sitename = "ImageFiltering",
20-
pages = [
17+
modules=[ImageFiltering, OffsetArrays, Kernel, KernelFactors, ImageFiltering.MapWindow],
18+
format=format,
19+
sitename="ImageFiltering",
20+
pages=[
2121
"index.md",
22-
demos,
23-
"Function reference" => "function_reference.md"
22+
"Tutorials" => [
23+
"Tutorial 1" => "tutorials/tutorial1.md",
24+
],
25+
demos,
26+
"Filtering images" => "filters.md",
27+
"Kernels" => "kernels.md",
28+
"Gradients" => "gradients.md",
29+
"Map window" => "mapwindows.md",
30+
"Padding arrays" => "padarrays.md",
31+
"Reference" => [
32+
"Technical overview" => "reference/technical.md"
33+
"Function reference" => "reference/function_reference.md"
34+
],
2435
],
2536
# Note(johnnychen94): doctest is moved as part of unit test for two reasons:
2637
# - we want to run doctest for various Julia versions on various platforms.
2738
# - `doctest=true` for `makedocs` will trigger not only doctest of ImageFiltering but also
2839
# that of other packages listed in `modules`. It usually throws warnings that don't
2940
# belong to the scope of this package.
30-
doctest = false
41+
doctest=false
3142
)
3243

3344
demos_cb()

Diff for: docs/src/.DS_Store

10 KB
Binary file not shown.

Diff for: docs/src/assets/.DS_Store

8 KB
Binary file not shown.

Diff for: docs/src/assets/figures/.DS_Store

6 KB
Binary file not shown.
File renamed without changes.

Diff for: docs/src/assets/figures/padintro.png

628 KB
Loading

Diff for: docs/src/assets/figures/pluto-00001.png

25.3 KB
Loading

Diff for: docs/src/assets/figures/pluto-00002.png

2.49 MB
Loading

Diff for: docs/src/assets/figures/pluto-00003.png

895 KB
Loading

Diff for: docs/src/assets/figures/pluto-00004.png

32 KB
Loading

Diff for: docs/src/assets/figures/pluto-00005.png

3.03 MB
Loading

Diff for: docs/src/assets/figures/pluto-00006.png

2.72 MB
Loading

Diff for: docs/src/assets/figures/pluto-00007.png

1.41 MB
Loading

Diff for: docs/src/assets/logo.svg

+64
Loading

Diff for: docs/src/assets/logo_dark.svg

+64
Loading

0 commit comments

Comments
 (0)