Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
<td align="center">
<b>Documentation</b>
<br>
<a href="https://harmoniqs.github.io/QuantumCollocation.jl/stable/">
<a href="https://docs.harmoniqs.co/QuantumCollocation/dev/">
<img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="Stable"/>
</a>
<a href="https://harmoniqs.github.io/QuantumCollocation.jl/dev/">
<a href="https://docs.harmoniqs.co/QuantumCollocation/dev/">
<img src="https://img.shields.io/badge/docs-dev-blue.svg" alt="Dev"/>
</a>
<a href="https://arxiv.org/abs/2305.03261">
Expand Down
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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) && occursin("-->", line)
Expand Down
Binary file added docs/src/assets/animation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/src/lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,9 @@ Modules = [QuantumCollocation.TrajectoryInitialization]
## Trajectory Interpolations
```@autodocs
Modules = [QuantumCollocation.TrajectoryInterpolations]
```

## Quantum System Templates
```@autodocs
Modules = [QuantumCollocation.QuantumSystemTemplates]
```
Loading