Add utils section to documentation

kestrelquantum · Nov 27, 2023 · 1aaa8cf · 1aaa8cf
1 parent 749a742
commit 1aaa8cf
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/docs/literate/man/utils.jl b/docs/literate/man/utils.jl
@@ -0,0 +1,13 @@
+# # Utilities
+
+# ## Gates
+
+# ## States
+
+# ## Operators
+
+# ## Isomorphisms
+
+# ## Measurements
+
+# ## Subspaces
diff --git a/docs/make.jl b/docs/make.jl
@@ -54,7 +54,6 @@ end
 makedocs(;
     modules=[QuantumCollocation],
     authors="Aaron Trowbridge <aaron.j.trowbridge@gmail.com> and contributors",
-    repo="https://github.com/aarontrowbridge/QuantumCollocation.jl/blob/{commit}{path}#{line}",
     sitename="QuantumCollocation.jl",
     format=format,
     pages=pages,

diff --git a/docs/src/generated/man/utils.md b/docs/src/generated/man/utils.md
@@ -2,6 +2,20 @@
 EditURL = "../../../literate/man/utils.jl"
 ```
 
+# Utilities
+
+## Gates
+
+## States
+
+## Operators
+
+## Isomorphisms
+
+## Measurements
+
+## Subspaces
+
 ---
 
 *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -34,6 +34,7 @@ where $B(a_t)$ and $F(a_t)$ are the *backward* and *forward* Pade operators, and
 This implementation is possible because direct collocation allows for the dynamics to be implicit. Since numerically calculating matrix exponentials inherently requires an approximation -- the Padé approximant is commonly used -- utilizing this formulation significantly improves performance, as, at least here, no matrix inversion is required.
 
 
+## Index
 
 ```@index
 ```