Update Documenter compat and add missing docstrings to docs

qojulia · Jan 13, 2024 · 47a32d0 · 47a32d0
1 parent 00f35a8
commit 47a32d0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -4,6 +4,6 @@ PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
 QuantumOptics = "6e0679c1-51ea-5a7c-ac74-d61b76210b0c"
 
 [compat]
-Documenter = "~0.25"
+Documenter = "1"
 PyPlot = "2"
 QuantumOptics = "1"
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -54,6 +54,21 @@ geometry.box
 geometry.cube
 ```
 
+```@docs
+geometry.ring
+```
+
+```@docs
+geometry.lhc1
+```
+
+```@docs
+geometry.lhc1_p
+```
+
+```@docs
+geometry.excitation_phases
+```
 
 ## [Dipole-Dipole Interaction](@id API: Dipole-Dipole Interaction)
 

diff --git a/docs/src/geometry.md b/docs/src/geometry.md
@@ -9,6 +9,7 @@ In order to simplify creation of various particle distributions, a few helper fu
 * [`geometry.hexagonal`](@ref)
 * [`geometry.box`](@ref)
 * [`geometry.cube`](@ref)
+* [`geometry.ring`](@ref)
 
 They can be used directly to create a [`SpinCollection`](@ref):