more docs

Author: vpuri3

README.md

@@ -1,4 +1,4 @@
-# SciMLOperators.jl
+# `SciMLOperators.jl`
 
 *Unified operator interface for `SciML.ai` and beyond*
 
@@ -78,7 +78,7 @@ in-place cache so the operation is nonallocating.
 L2 = cache_operator(L2, u)
 L4 = cache_operator(L4, u)
 
-# allocation-free
+# allocation-free evaluation
 mul!(v, L2, u)
 L4(v, u, p, t)
 ```

docs/Project.toml

@@ -1,9 +1,7 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 SciMLOperators = "c0aeaf25-5076-4817-a8d5-81caf7dfa961"
 
 [compat]
 Documenter = "0.27"
-SciMLBase = "1.74"
 SciMLOperators = "0.2"

docs/pages.jl

@@ -1,6 +1,11 @@
 pages = [
          "Home" => "index.md",
-         "interface.md",
-         "premade_operators.md",
-         "tutorials/fftw.md"
+         "Interface" => "interface.md",
+         "Premade Operators" => "premade_operators.md",
+         "API" => "api.md",
+         "FFT Tutorial" => "tutorials/fftw.md",
+         # "tutorials/linear.md",
+         # "tutorials/nonlin.md",
+         # "tutorials/ode.md",
+         # "tutorials/lux.md",
         ]

docs/src/api.md

@@ -0,0 +1,5 @@
+
+```@autodocs
+Modules = [SciMLOperators]
+Order = [:function, :type]
+```

docs/src/assets/Project.toml

@@ -0,0 +1,7 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+SciMLOperators = "c0aeaf25-5076-4817-a8d5-81caf7dfa961"
+
+[compat]
+Documenter = "0.27"
+SciMLOperators = "0.2"

docs/src/index.md

@@ -1,6 +1,8 @@
 # SciMLOperators.jl: The SciML Operators Interface
 
-$(README)
+```@docs
+SciMLOperators
+```
 
 ## Reproducibility
 ```@raw html

docs/src/interface.md

@@ -1,5 +1,30 @@
 # The AbstractSciMLOperator Interface
 
+## Interface
+
+```@docs
+update_coefficients
+update_coefficients!
+cache_operator
+```
+
+## Traits
+
+```@docs
+isconstant
+iscached
+issquare
+islinear
+has_adjoint
+has_expmv
+has_expmv!
+has_exp
+has_mul
+has_mul!
+has_ldiv
+has_ldiv!
+```
+
 ## Formal Properties of SciMLOperators
 
 These are the formal properties that an `AbstractSciMLOperator` should obey
@@ -77,4 +102,4 @@ update_coefficients!(γ, nothing, nothing, nothing; my_special_scaling=7.0)
 # Use operator application form
 @show γ([2.0], nothing, nothing; my_special_scaling = 5.0)
 nothing # hide
-```
+```

docs/src/premade_operators.md

@@ -3,22 +3,32 @@
 ## Direct Operator Definitions
 
 ```@docs
-ScalarOperator
+ScalarOperator.IdentityOperator
 SciMLOperators.NullOperator
+ScalarOperator
 MatrixOperator
 DiagonalOperator
 AffineOperator
+AddVector
 FunctionOperator
+TensorProductOperator
 ```
 
-## Lazy Operator Compositions
+## Lazy Scalar Operator Combination
+
+```@docs
+SciMLOperators.AddedScalarOperator
+SciMLOperators.ComposedScalarOperator
+SciMLOperators.InvertedScalarOperator
+```
+## Lazy Operator Combination
 
 ```@docs
 SciMLOperators.ScaledOperator
-SciMLOperators.ComposedOperator
 SciMLOperators.AddedOperator
+SciMLOperators.ComposedOperator
 SciMLOperators.InvertedOperator
 SciMLOperators.InvertibleOperator
-SciMLOperators.AdjointedOperator
+SciMLOperators.AdjointOperator
 SciMLOperators.TransposedOperator
-```
+```

src/left.jl

@@ -40,6 +40,9 @@ end
 # fallback wrappers
 ###
 
+"""
+$TYPEDEF
+"""
 struct AdjointOperator{T,LType} <: AbstractSciMLOperator{T}
     L::LType
 
@@ -48,6 +51,9 @@ struct AdjointOperator{T,LType} <: AbstractSciMLOperator{T}
     end
 end
 
+"""
+$TYPEDEF
+"""
 struct TransposedOperator{T,LType} <: AbstractSciMLOperator{T}
     L::LType