reorganize and update documentation (#125)

* reorganize the documentation by splitting the manual into two parts: tutorials and package documentations
* add documentation introductions in the frontpage
* add packages introduction at the beginning of packages part
* update and add more refs
* update the "Getting started" page
* add docs for ImageDistances and ImageQualityIndexes
* some other minor changes

Author: johnnychen94

.travis.yml

@@ -3,7 +3,7 @@ language: julia
 os:
   - linux
 julia:
-  - 1.3
+  - 1
 env:
   - DOCUMENTER_DEBUG=true
 notifications:

Project.toml

@@ -16,6 +16,7 @@ ImageFeatures = "92ff4b2b-8094-53d3-b29d-97f740f06cef"
 ImageFiltering = "6a3955dd-da59-5b1f-98d4-e7296123deb5"
 ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
 ImageMetadata = "bc367c6b-8a6b-528e-b4bd-a4b897500b49"
+ImageMorphology = "787d08f9-d448-5407-9aad-5290dd7ab264"
 ImageSegmentation = "80713f31-8817-5129-9cf8-209ff8fb23e1"
 ImageShow = "4e3cecfd-b093-5904-9786-8bbb286a6a31"
 Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
@@ -38,13 +39,14 @@ Documenter = "0.24.2"
 FileIO = "1"
 FixedPointNumbers = "0"
 ImageAxes = "0"
-ImageCore = "0"
 ImageContrastAdjustment = "0.3"
+ImageCore = "0"
 ImageDraw = "0"
 ImageFeatures = "0"
 ImageFiltering = "0"
 ImageMagick = "0, 1"
 ImageMetadata = "0"
+ImageMorphology = "0.2"
 ImageSegmentation = "1"
 ImageShow = "0"
 Images = "0.22"

docs/examples/color_channels/color_separations_svd.jl

@@ -6,7 +6,7 @@
 # This demonstration shows how to work with color channels to explore image compression
 # using the Singular Value Decomposition (SVD).
 
-using Images, TestImages, MosaicViews
+using Images, TestImages
 using LinearAlgebra
 
 img = float.(testimage("mandrill"))
@@ -29,9 +29,9 @@ nothing #hide #md
 # $512 \times 512$ numbers. Hence this gives us a compression ratio $19.55\%$ if we don't consider
 # the storage type.
 
-## after julia v1.1:
-## svdfactors = svd.(eachslice(channels; dims=1))
-svdfactors = (svd(channels[1,:,:]), svd(channels[2,:,:]), svd(channels[3,:,:]))
+## before julia v1.1:
+## svdfactors = (svd(channels[1,:,:]), svd(channels[2,:,:]), svd(channels[3,:,:]))
+svdfactors = svd.(eachslice(channels; dims=1))
 imgs = map((10, 50, 100)) do k
     colorview(RGB, rank_approx.(svdfactors, k)...)
 end

docs/examples/spatial_transformation/alpha_compositing.jl

@@ -8,8 +8,8 @@
 # [OffsetArrays](https://github.com/JuliaArrays/OffsetArrays.jl) and
 # [PaddedViews](https://github.com/JuliaArrays/PaddedViews.jl)
 
-using Images, MosaicViews
-using OffsetArrays, PaddedViews # provide `OffsetArray` and `paddedviews`
+using Images
+using OffsetArrays # provide `OffsetArray`
 
 # ## 1. basic offset and pad operation
 
@@ -100,4 +100,4 @@ color_panel = color_panel[axes(red_c)...] # crop empty region
 
 # --- save covers --- #src
 using FileIO #src
-save("assets/alpha_compositing.png", color_panel) #src
+save("assets/alpha_compositing.png", map(clamp01nan, color_panel)) #src

docs/examples/spatial_transformation/image_diffview.jl

@@ -9,7 +9,7 @@
 # [`imshowpair`](https://www.mathworks.com/help/images/ref/imshowpair.html), but in JuliaImages
 # it is not that indispensable.
 
-using Images, MosaicViews
+using Images
 using TestImages
 
 img = float.(testimage("cameraman"))
@@ -41,4 +41,4 @@ mosaicview(plain_diffview, RGB_diffview, Gray_diffview;
 
 # --- save covers --- #src
 using FileIO #src
-save("assets/image_diffview.png", RGB_diffview) #src
+save("assets/image_diffview.png", map(clamp01nan, RGB_diffview)) #src

docs/make.jl

@@ -1,6 +1,6 @@
 using Documenter, DemoCards
 using Images, ImageFiltering, ImageSegmentation, ImageFeatures, PaddedViews
-using ImageContrastAdjustment
+using ImageContrastAdjustment, TestImages, FileIO, MosaicViews, ImageMorphology
 
 branch = "master"
 
@@ -13,27 +13,30 @@ format = Documenter.HTML(edit_link = "source",
 
 makedocs(modules  = [Images, ImageCore, Colors, ColorTypes, FixedPointNumbers, ImageAxes,
                     ImageFeatures, ImageFiltering, ImageMetadata, ImageContrastAdjustment,
+                    ImageDistances, ImageQualityIndexes, MosaicViews, TestImages, FileIO,
                     ImageSegmentation, ImageTransformations, PaddedViews, ImageMorphology],
          format   = format,
          sitename = "JuliaImages",
          pages    = ["Home" => "index.md",
                      "install.md",
-                     "Manual" => Any[
-                         "quickstart.md",
-                         "arrays_colors.md",
-                         "conversions_views.md",
-                         "indexing.md",
-                         "imageaxes.md",
-                         "imagefiltering.md",
-                         "imagemetadata.md",
-                         "imagesegmentation.md",
-                         "imagetransformations.md",
-                         "imagefeatures.md",
-                         "troubleshooting.md",
+                     "Tutorials" => Any[
+                         joinpath("tutorials", "quickstart.md"),
+                         joinpath("tutorials", "arrays_colors.md"),
+                         joinpath("tutorials", "conversions_views.md"),
+                         joinpath("tutorials", "indexing.md")
+                     ],
+                     "Packages" => Any[
+                         "Introduction" => joinpath("pkgs", "index.md"),
+                         "ImageAxes.jl" => joinpath("pkgs", "axes", "index.md"),
+                         "ImageMetaData.jl" => joinpath("pkgs", "metadata", "index.md"),
+                         "ImageSegmentation.jl" => joinpath("pkgs", "segmentation", "index.md"),
+                         "ImageTransformations.jl" => joinpath("pkgs", "transformations", "index.md"),
+                         "ImageFeatures.jl" => joinpath("pkgs", "features", "index.md")
                      ],
                      "Demos" => demos,
-                     "function_reference.md",
+                     "References" => "function_reference.md",
                      "api_comparison.md",
+                    #  "faqs.md"
                     ])
 
 demos_cb()