fix documentation CI and enhancements

Author: Fe-r-oz

docs/src/resources/api.md

@@ -315,4 +315,13 @@ meshgrid
 ```@docs
 plot_wigner
 plot_fock_distribution
+plot_bloch
+Bloch
+render
+add_points!
+add_vectors!
+add_line!
+add_arc!
+clear!
+add_states!
 ```

docs/src/users_guide/plotting_the_bloch_sphere.md

@@ -15,56 +15,63 @@ In [QuantumToolbox.jl](https://qutip.org/QuantumToolbox.jl/), this can be done u
 
 ## Create a Bloch Sphere
 
+In [QuantumToolbox.jl](https://qutip.org/QuantumToolbox.jl/), creating a [`Bloch`](@ref) sphere is accomplished by calling either:
+
 ```@example Bloch_sphere_rendering
 b = Bloch();
-fig, _ = render(b)
+```
+
+which will load an instance of [`Bloch`](@ref). Before getting into the details of these objects, we can simply plot the blank [`Bloch`](@ref) sphere associated with these instances via:
+
+```@example Bloch_sphere_rendering
+fig, _ = render(b);
+fig
 ```
 
 ## Add a Single Data Point
 
+As an example, we can add a single data point via [`add_points!`](@ref):
+
 ```@example Bloch_sphere_rendering
-pnt = [1 / sqrt(3), 1 / sqrt(3), 1 / sqrt(3)]
-add_points!(b, pnt)
-fig, _ = render(b)
+pnt = [1 / sqrt(3), 1 / sqrt(3), 1 / sqrt(3)];
+add_points!(b, pnt);
+fig, _ = render(b);
 fig
 ```
 
 ## Add a Single Vector
 
+and then a single vector via  [`add_vectors!`](@ref):
+
 ```@example Bloch_sphere_rendering
-clear!(b)
 vec = [0, 1, 0];
 add_vectors!(b, vec)
 fig, _ = render(b)
 fig
 ```
 
-## Add Multiple Vectors
+and then add another vector corresponding to the ``|0\rangle`` state:
 
 ```@example Bloch_sphere_rendering
-clear!(b)
-vecs = [[1, 0, 0], [0, 1, 0], [0, 0, 1]]
-add_vectors!(b, vecs)
+x = basis(2, 0)
+add_states!(b, [x])
 fig, _ = render(b)
 fig
 ```
 
-# Add Arc, Line, and Vector
+## Add Multiple Vectors
+
+We can also plot multiple points, vectors, and states at the same time by passing arrays instead of individual elements via  [`add_vectors!](@ref). Before giving an example, we can use [`clear!`](@ref) to remove the current data from our [`Bloch`](@ref) sphere instead of creating a new instance:
 
 ```@example Bloch_sphere_rendering
 clear!(b)
-vec = [[1, 0, 0], [0, 1, 0], [0, 0, 1]];
-add_vectors!(b, vec);
-add_line!(b, [1,0,0], [0,1,0])
-add_arc!(b, [1, 0, 0], [0, 1, 0], [0, 0, 1])
 fig, _ = render(b)
 fig
 ```
 
-# Add Quantum States
+Now on the same [`Bloch`](@ref) sphere, we can plot the three states via [`add_states!`](@ref) associated with the `x`, `y`, and `z` directions:
 
 ```@example Bloch_sphere_rendering
-clear!(b)
 x = basis(2, 0) + basis(2, 1)
 y = basis(2, 0) - im * basis(2, 1)
 z = basis(2, 0)
@@ -74,29 +81,56 @@ fig, _ = render(b)
 fig
 ```
 
-## Add Multiple Points Around the Equator
+a similar method works for adding vectors:
+
+```@example Bloch_sphere_rendering
+clear!(b)
+vecs = [[1, 0, 0], [0, 1, 0], [0, 0, 1]]
+add_vectors!(b, vecs)
+fig, _ = render(b)
+fig
+```
+
+# Add Arc, Line, and Vector
+
+You can also add lines and arcs via [`add_line!`](@ref) and [`add_arc!`](@ref) respectively:
+
+```@example Bloch_sphere_rendering
+clear!(b)
+vec = [[1, 0, 0], [0, 1, 0], [0, 0, 1]];
+add_vectors!(b, vec);
+add_line!(b, [1,0,0], [0,1,0])
+add_arc!(b, [1, 0, 0], [0, 1, 0], [0, 0, 1])
+fig, _ = render(b)
+fig
+```
+
+## Add Multiple Points
+
+Adding multiple points to the [`Bloch`](@ref) sphere works slightly differently than adding multiple states or vectors. For example, lets add a set of `20` points around the equator (after calling [`clear!`](@ref)):
 
 ```@example Bloch_sphere_rendering
 th = range(0, 2π; length=20);
 clear!(b)
 xp = cos.(th);
 yp = sin.(th);
 zp = zeros(20);
-pnts = [xp, yp, zp] ;
-pnts = Matrix(hcat(xp, yp, zp)');
+pnts = [xp, yp, zp];
 add_points!(b, pnts);
 fig, ax = render(b);
 fig
 ```
 
 ## Add Another Set of Points
 
+If we want to plot additional qubit states we can call additional [`add_points!`](@ref) functions:
+
 ```@example Bloch_sphere_rendering
 xz = zeros(20);
 yz = sin.(th);
 zz = cos.(th);
-points = hcat(xz, yz, zz)';
-add_points!(b, Matrix(points), meth=:s, color="orange");
+pnts = [xz, yz, zz];
+add_points!(b, pnts);
 fig, ax = render(b);
 fig
 ```