diff --git a/.gitignore b/.gitignore index 1241cb28..ac13bb9f 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,8 @@ deps/src/ # Build artifacts for creating documentation generated by the Documenter package docs/build/ docs/site/ +## generated by make.jl +docs/src/index.md # File generated by Pkg, the package manager, based on a corresponding Project.toml # It records a fixed state of all packages used by the project. As such, it should not be diff --git a/README.md b/README.md index a94632b8..56e918f8 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ Documentation
- + Stable - + Dev diff --git a/docs/make.jl b/docs/make.jl index 54cde02f..707e811b 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,7 +4,7 @@ using Literate push!(LOAD_PATH, joinpath(@__DIR__, "..", "src")) -@info "Building Documenter site for NamedTrajectories.jl" +@info "Building Documenter site for QuantumCollocation.jl" open(joinpath(@__DIR__, "src", "index.md"), write = true) do io for line in eachline(joinpath(@__DIR__, "..", "README.md")) if occursin("", line) diff --git a/docs/src/assets/animation.gif b/docs/src/assets/animation.gif new file mode 100644 index 00000000..69e1adf7 Binary files /dev/null and b/docs/src/assets/animation.gif differ diff --git a/docs/src/lib.md b/docs/src/lib.md index 835b8de1..feba8ff8 100644 --- a/docs/src/lib.md +++ b/docs/src/lib.md @@ -28,4 +28,9 @@ Modules = [QuantumCollocation.TrajectoryInitialization] ## Trajectory Interpolations ```@autodocs Modules = [QuantumCollocation.TrajectoryInterpolations] +``` + +## Quantum System Templates +```@autodocs +Modules = [QuantumCollocation.QuantumSystemTemplates] ``` \ No newline at end of file