update document

docs/make.jl

@@ -10,15 +10,11 @@ makedocs(
         assets = [ asset("assets/logo.svg", class=:ico, islocal = true) ]),
     pages=[
         "Home"=>"index.md",
-        "Manual"=>Any[
-            "Quick Start"=>"guide.md",
-        ]
-        # "examples.md",
-        # "stochastics.md",
-        # "analytics.md",
-        # "integration.md",
-        # "reference.md",
-        # "about.md"
+        # "Tutorial"=>Any[
+            # "Quick Start"=>"guide.md",
+        # ],
+        "Quick Start"=>"guide.md",
+        "Manual"=>"manual.md"
     ],
 )
 

docs/src/index.md

@@ -10,79 +10,3 @@ From the Julia REPL, type `]` to enter the Pkg REPL mode and run
 ```
 pkg> add SpinShuttling
 ```
-
-## APIs
-
-```@meta
-CurrentModule = SpinShuttling
-```
-
-### Spin Shuttling Models
-
-```@docs
-OneSpinModel
-```
-
-```@docs
-OneSpinForthBackModel
-```
-
-```@docs
-TwoSpinModel
-```
-
-```@docs
-TwoSpinParallelModel
-```
-
-### Fidelity Metric
-
-```@docs
-fidelity
-```
-
-```@docs
-sampling
-```
-
-```@docs
-averagefidelity
-```
-
-```@docs
-W
-```
-
-### Stochastics
-
-```@docs
-OrnsteinUhlenbeckField
-```
-
-```@docs
-PinkBrownianField
-```
-
-```@docs
-RandomFunction
-```
-
-```@docs
-CompositeRandomFunction
-```
-
-```@docs
-characteristicfunction
-```
-
-```@docs
-characteristicvalue
-```
-
-```@docs
-covariancematrix
-```
-
-```@docs
-covariance
-```

docs/src/manual.md

@@ -0,0 +1,76 @@
+
+## APIs
+
+```@meta
+CurrentModule = SpinShuttling
+```
+
+### Spin Shuttling Models
+
+```@docs
+OneSpinModel
+```
+
+```@docs
+OneSpinForthBackModel
+```
+
+```@docs
+TwoSpinModel
+```
+
+```@docs
+TwoSpinParallelModel
+```
+
+### Fidelity Metric
+
+```@docs
+fidelity
+```
+
+```@docs
+sampling
+```
+
+```@docs
+averagefidelity
+```
+
+```@docs
+W
+```
+
+### Stochastics
+
+```@docs
+OrnsteinUhlenbeckField
+```
+
+```@docs
+PinkBrownianField
+```
+
+```@docs
+RandomFunction
+```
+
+```@docs
+CompositeRandomFunction
+```
+
+```@docs
+characteristicfunction
+```
+
+```@docs
+characteristicvalue
+```
+
+```@docs
+covariancematrix
+```
+
+```@docs
+covariance
+```