fix basic generated docs pages

kestrelquantum · Nov 22, 2024 · 509f228 · 509f228
1 parent 6d77db1
commit 509f228
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 16 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,5 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 PiccoloQuantumObjects = "5a402ddf-f93c-42eb-975e-5582dcda653d"
 Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
diff --git a/docs/make.jl b/docs/make.jl
@@ -8,18 +8,7 @@ push!(LOAD_PATH, joinpath(@__DIR__, "..", "src"))
 
 pages = [
     "Home" => "index.md",
-    "Quickstart Guide" => "generated/quickstart.md",
-    "Contribution Guide" => "contribution_guide.md",
-    "Manual" => [
-        "Problem Templates" => "generated/man/problem_templates.md",
-        "Embedded Operators" => "generated/man/embedded_operators.md",
-    ],
-    "Examples" => [
-        "Two Qubit Gates" => "generated/examples/two_qubit_gates.md",
-        "Multilevel Transmon" => "generated/examples/multilevel_transmon.md",
-    ],
     "Library" => "lib.md",
-    "Release Notes" => "release_notes.md",
 ]
 
 format = Documenter.HTML(;
@@ -55,7 +44,7 @@ for (root, _, files) ∈ walkdir(lit), file ∈ files
 end
 
 makedocs(;
-    modules=[QuantumCollocation],
+    modules=[PiccoloQuantumObjects],
     authors="Aaron Trowbridge <[email protected]> and contributors",
     sitename="PiccoloQuantumObjects.jl",
     format=format,

diff --git a/docs/src/lib.md b/docs/src/lib.md
@@ -1,10 +1,35 @@
-## Quantum Object Utils
+
+## Quantum Systems
+```@autodocs
+Modules = [PiccoloQuantumObjects.QuantumSystems]
+```
+
+## Composite Quantum Systems
 ```@autodocs
-Modules = [QuantumCollocation.QuantumObjectUtils]
+Modules = [PiccoloQuantumObjects.CompositeQuantumSystems]
 ```
 
-## Quantum Systems 
+## Gates
 ```@autodocs
-Modules = [QuantumCollocation.QuantumSystems]
+Modules = [PiccoloQuantumObjects.Gates]
 ```
 
+## Embedded Operators
+```@autodocs
+Modules = [PiccoloQuantumObjects.EmbeddedOperators]
+```
+
+## Isomorphisims
+```@autodocs
+Modules = [PiccoloQuantumObjects.Isomorphisms]
+```
+
+## Quantum Object Utilities
+```@autodocs
+Modules = [PiccoloQuantumObjects.QuantumObjectUtils]
+```
+
+## Quantum System Utilities
+```@autodocs
+Modules = [PiccoloQuantumObjects.QuantumSystemUtils]
+```