[docs] improve api reference

Author: johannes-moegerle

docs/api_reference.rst

@@ -0,0 +1,76 @@
+API Reference
+=============
+
+
+The RydState python API can be accessed via the ``rydstate`` module by
+
+.. code-block:: python
+
+    import rydstate
+
+
+All the available classes, methods and functions are documented below:
+
+.. currentmodule:: rydstate
+
+**Rydberg States**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       RydbergStateSQDT
+       RydbergStateSQDTAlkali
+       RydbergStateSQDTAlkalineLS
+       RydbergStateSQDTAlkalineJJ
+       RydbergStateSQDTAlkalineFJ
+
+**Rydberg Basis**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       BasisSQDTAlkali
+       BasisSQDTAlkalineLS
+       BasisSQDTAlkalineJJ
+       BasisSQDTAlkalineFJ
+
+**Angular module**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       angular.AngularKetLS
+       angular.AngularKetJJ
+       angular.AngularKetFJ
+       angular.AngularState
+       angular.utils
+
+
+**Radial module**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       radial.RadialKet
+       radial.Wavefunction
+       radial.Model
+       radial.numerov
+
+**Species module and parameters**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       species.SpeciesObject
+       species.HydrogenTextBook
+       species.Hydrogen
+       species.Lithium
+       species.Sodium
+       species.Potassium
+       species.Rubidium
+       species.Cesium
+       species.Strontium87
+       species.Strontium88
+       species.Ytterbium171
+       species.Ytterbium173
+       species.Ytterbium174

docs/index.rst

@@ -9,11 +9,4 @@
     :hidden:
 
     examples.rst
-
-
-.. toctree::
-    :maxdepth: 2
-    :caption: References
-    :hidden:
-
-    modules.rst
+    api_reference.rst

docs/modules.rst

@@ -27,11 +27,12 @@ def try_trivial_spin_addition(s_1: float, s_2: float, s_tot: float | None, name:
 
 
 def check_spin_addition_rule(s_1: float, s_2: float, s_tot: float) -> bool:
-    """Check if the spin addition rule is satisfied.
+    r"""Check if the spin addition rule is satisfied.
 
     This means check the following conditions:
-    - |s_1 - s_2| <= s_tot <= s_1 + s_2
-    - s_1 + s_2 + s_tot is an integer
+    :math:`|s_1 - s_2| \leq s_{tot} \leq s_1 + s_2`
+    and
+    :math:`s_1 + s_2 + s_{tot}` is an integer
     """
     return abs(s_1 - s_2) <= s_tot <= s_1 + s_2 and (s_1 + s_2 + s_tot) % 1 == 0
 

src/rydstate/angular/utils.py

@@ -1,3 +1,4 @@
+from rydstate.radial import numerov
 from rydstate.radial.grid import Grid
 from rydstate.radial.model import Model, PotentialType
 from rydstate.radial.numerov import run_numerov_integration
@@ -14,5 +15,6 @@
     "WavefunctionNumerov",
     "WavefunctionWhittaker",
     "calc_radial_matrix_element_from_w_z",
+    "numerov",
     "run_numerov_integration",
 ]