Merge pull request #154 from kestrelquantum/embedded-operators-docs

Embedded operators docs

Project.toml

@@ -1,7 +1,7 @@
 name = "QuantumCollocation"
 uuid = "0dc23a59-5ffb-49af-b6bd-932a8ae77adf"
 authors = ["Aaron Trowbridge <[email protected]> and contributors"]
-version = "0.2.1"
+version = "0.2.2"
 
 [deps]
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
@@ -29,22 +29,22 @@ TrajectoryIndexingUtils = "6dad8b7f-dd9a-4c28-9b70-85b9a079bfc8"
 
 [compat]
 BenchmarkTools = "1.5"
-CairoMakie = "0.10, 0.11, 0.12"
+CairoMakie = "0.12"
 Distributions = "0.25"
 Einsum = "0.4"
 ExponentialAction = "0.2"
 ForwardDiff = "0.10"
 IJulia = "1.25"
 Interpolations = "0.15"
 Ipopt = "1.6"
-JLD2 = "0.4"
+JLD2 = "0.5"
 MathOptInterface = "1.31"
 NamedTrajectories = "0.2"
 ProgressMeter = "1.10"
 Reexport = "1.2"
-Symbolics = "6.2"
-TestItemRunner = "0.2"
-TestItems = "0.1"
+Symbolics = "6.11"
+TestItemRunner = "1.0"
+TestItems = "1.0"
 TrajectoryIndexingUtils = "0.1"
 julia = "1.10"
 

README.md

@@ -81,6 +81,27 @@ using Revise
 using QuantumCollocation
 ```
 
+### Documentation
+
+Documentation is built using [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) and uses [Literate.jl](https://github.com/fredrikekre/Literate.jl) to generate markdown files from scripts stored in [docs/literate](docs/literate). To build the documentation locally, start julia with the docs environment:
+
+```bash
+julia --project=docs
+```
+
+Then (for ease of development) load the following packages:
+
+```julia
+using Revise, LiveServer, QuantumCollocation
+```
+
+To live-serve the docs, run
+```julia
+servedocs(literate_dir="docs/literate", skip_dir="docs/src/generated")
+```
+
+Changes made to files in the docs directory should be automatically reflected in the live server. To reflect changes in the source code (e.g. doc strings), since we are using Revise, simply kill the live server running in the REPL (with, e.g., Ctrl-C) and restart it with the above command. 
+
 ### Tips for Visual Studio Code
 __Julia extension__ You can run Julia notebooks and much more with [the Julia extension](https://code.visualstudio.com/docs/languages/julia). Upon opening your project folder in VS code and attempting to run an `.ipynb`, you will see that VS Code finds the interpreters managed by juliaup and defaults to using the environment based on the _Project.toml_ in the project directory.