fixed & updated docs

Author: wildart

docs/make.jl

@@ -9,7 +9,7 @@ makedocs(
         "Home" => "index.md",
         "Tutorial" => "tutorial.md",
         "Constraints" => "constraints.md",
-        "COnvergence" => "convergence.md",
+        "Convergence" => "convergence.md",
         "Algorithms" => [
             "Genetic Algorithm" => "ga.md",
             "Differential Evolution" => "de.md",

docs/src/constraints.md

@@ -110,7 +110,7 @@ con = WorstFitnessConstraints(lx, ux, lc, uc, c)
 results = Evolutionary.optimize(f, con, x0, ga)
 ```
 
-## Auxiliary Functions
+## [Auxiliary Functions](@id cons_aux_funcs)
 
 ```@docs
 value(c::Evolutionary.AbstractConstraints, x)

docs/src/crossover.md

@@ -40,7 +40,7 @@ BSX
 ### Real-valued Crossovers
 
 ```@docs
-identity
+Evolutionary.genop(::T,::T) where {T<:AbstractVector}
 DC
 AX
 WAX

docs/src/dev.md

@@ -53,13 +53,10 @@ initial_population
 ### Constraints
 
 All constraints derived from the `AbstractConstraints` abstract type.
-Usually the derived type wraps a `ConstraintBounds` object, so the
-
-Following methods can be overridden for the derived types:
-
-```@docs
-value(::AbstractConstraints, x)
-```
+For the derived type, the [`constraints interface functions`](@ref cons_aux_funcs)
+have to be implemented.
+If the derived type wraps a `ConstraintBounds` object, the [`bounds`](@ref) method
+should be implemented.
 
 Following auxiliary functions are available for every derived type of `AbstractConstraints`.
 

docs/src/index.md

@@ -17,5 +17,5 @@ using Evolutionary
 result = Evolutionary.optimize(
       x -> sum(x.^2), ones(3),
       GA(populationSize = 100, selection = susinv,
-         crossover = discrete, mutation = domainrange(ones(3))))
+         crossover = DC, mutation = PLM()))
 ```

docs/src/mutation.md

@@ -14,6 +14,7 @@ See [Strategies](@ref) section for detailed description of ES strategies.
 List of ES mutation operations:
 
 ```@docs
+Evolutionary.nop(::AbstractVector, ::AbstractStrategy)
 gaussian(::AbstractVector, ::IsotropicStrategy)
 gaussian(::AbstractVector, ::AnisotropicStrategy)
 cauchy(::AbstractVector, ::IsotropicStrategy)

docs/src/tutorial.md

@@ -87,7 +87,8 @@ We currently recommend the statically dispatched interface by using the `Evoluti
 ```julia
 res = Evolutionary.optimize(x->-sum(x),
                             BitVector(zeros(30)),
-                            GA(selection=uniformranking(5),mutation=flip,crossover=singlepoint),
+                            GA(selection=uniformranking(5),
+                            mutation=flip, crossover=SPX),
                             Evolutionary.Options(iterations=10))
 ```