docs

Author: J-C-Q

docs/make.jl

@@ -1,27 +1,30 @@
 using MonitoredQuantumCircuits
 using Documenter
 
-DocMeta.setdocmeta!(MonitoredQuantumCircuits, :DocTestSetup, :(using MonitoredQuantumCircuits); recursive=true)
+# DocMeta.setdocmeta!(MonitoredQuantumCircuits, :DocTestSetup, :(using MonitoredQuantumCircuits); recursive=true)
 
 makedocs(;
-    modules=[MonitoredQuantumCircuits],
-    authors="Quinten Preiss",
-    repo="https://github.com/J-C-Q/MonitoredQuantumCircuits.jl/blob/{commit}{path}#{line}",
-    sitename="MonitoredQuantumCircuits.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://J-C-Q.github.io/MonitoredQuantumCircuits.jl",
-        repolink="https://github.com/J-C-Q/MonitoredQuantumCircuits.jl",
-        edit_link="main",
-        assets=String["assets/favicon.ico", "assets/style.css"],
-        sidebar_sitename=false
-    ),
     pages=[
         "Home" => "index.md",
-    ]
+        "Tutorial" => "tutorial.md",
+        "API Reference" => "api.md",
+    ],
+    modules=[MonitoredQuantumCircuits],
+    warnonly=true,
+    # authors="Quinten Preiss",
+    # repo="https://github.com/J-C-Q/MonitoredQuantumCircuits.jl/blob/{commit}{path}#{line}",
+    sitename="MonitoredQuantumCircuits.jl",
+    # format=Documenter.HTML(;
+    #     prettyurls=get(ENV, "CI", "false") == "true",
+    #     canonical="https://J-C-Q.github.io/MonitoredQuantumCircuits.jl",
+    #     repolink="https://github.com/J-C-Q/MonitoredQuantumCircuits.jl",
+    #     edit_link="main",
+    #     assets=String["assets/favicon.ico", "assets/style.css"],
+    #     sidebar_sitename=false
+    # )
 )
 
 deploydocs(;
-    repo="github.com/J-C-Q/MonitoredQuantumCircuits.jl",
-    devbranch="main"
+    repo="github.com/J-C-Q/MonitoredQuantumCircuits.jl.git",
+    # devbranch="main"
 )

docs/src/api.md

@@ -0,0 +1 @@
+# API

docs/src/index.md

@@ -1,18 +1,18 @@
-```@meta
+<!-- ```@meta
 CurrentModule = MonitoredQuantumCircuits
-```
+``` -->
 
 # MonitoredQuantumCircuits
 
-Documentation for [MonitoredQuantumCircuits](https://github.com/J-C-Q/MonitoredQuantumCircuits.jl).
+<!-- Documentation for [MonitoredQuantumCircuits](https://github.com/J-C-Q/MonitoredQuantumCircuits.jl).
 
 ```@index
-```
-
-<!-- ```@docs
-nQubits(operation::Operation)
 ``` -->
 
-```@autodocs
-Modules = [MonitoredQuantumCircuits]
+```@docs
+MonitoredQuantumCircuits
 ```
+
+<!-- ```@autodocs
+Modules = [MonitoredQuantumCircuits]
+``` -->

docs/src/tutorial.md

@@ -0,0 +1 @@
+# Tutorial