Skip to content

Commit 4f9102f

Browse files
johannes-moegerlejohannes-moegerle
committed
[docs] improve api reference
1 parent 195cf66 commit 4f9102f

8 files changed

Lines changed: 102 additions & 63 deletions

File tree

‎docs/api/angular.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Angular module
2+
==============
3+
4+
.. currentmodule:: rydstate
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
9+
angular.AngularKetLS
10+
angular.AngularKetJJ
11+
angular.AngularKetFJ
12+
angular.AngularState
13+
angular.utils

‎docs/api/basis.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Rydberg Basis
2+
=============
3+
4+
.. currentmodule:: rydstate
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
9+
BasisSQDTAlkali
10+
BasisSQDTAlkalineLS
11+
BasisSQDTAlkalineJJ
12+
BasisSQDTAlkalineFJ
13+
BasisMQDT

‎docs/api/radial.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Radial module
2+
=============
3+
4+
.. currentmodule:: rydstate
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
9+
radial.RadialKet
10+
radial.Wavefunction
11+
radial.Model
12+
radial.numerov

‎docs/api/rydberg_states.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Rydberg States
2+
==============
3+
4+
.. currentmodule:: rydstate
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
9+
RydbergStateSQDT
10+
RydbergStateSQDTAlkali
11+
RydbergStateSQDTAlkalineLS
12+
RydbergStateSQDTAlkalineJJ
13+
RydbergStateSQDTAlkalineFJ
14+
RydbergStateMQDT

‎docs/api/species_mqdt.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
MQDT Parameters
2+
===============
3+
4+
.. currentmodule:: rydstate
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
9+
species.SpeciesObjectMQDT
10+
species.FModel
11+
species.FModelSQDT
12+
species.Strontium87MQDT
13+
species.Strontium88MQDT
14+
species.Ytterbium171MQDT
15+
species.Ytterbium173MQDT
16+
species.Ytterbium174MQDT

‎docs/api/species_sqdt.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
SQDT Parameters
2+
===============
3+
4+
.. currentmodule:: rydstate
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
9+
species.SpeciesObjectSQDT
10+
species.HydrogenTextBook
11+
species.Hydrogen
12+
species.Lithium
13+
species.Sodium
14+
species.Potassium
15+
species.Rubidium
16+
species.Cesium
17+
species.Strontium87
18+
species.Strontium88
19+
species.Ytterbium171
20+
species.Ytterbium173
21+
species.Ytterbium174

‎docs/api_reference.rst‎

Lines changed: 9 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -11,66 +11,12 @@ The RydState python API can be accessed via the ``rydstate`` module by
1111
1212
All the available classes, methods and functions are documented below:
1313

14-
.. currentmodule:: rydstate
15-
16-
**Rydberg States**
17-
18-
.. autosummary::
19-
:toctree: _autosummary/
20-
21-
RydbergStateSQDT
22-
RydbergStateSQDTAlkali
23-
RydbergStateSQDTAlkalineLS
24-
RydbergStateSQDTAlkalineJJ
25-
RydbergStateSQDTAlkalineFJ
26-
27-
**Rydberg Basis**
28-
29-
.. autosummary::
30-
:toctree: _autosummary/
31-
32-
BasisSQDTAlkali
33-
BasisSQDTAlkalineLS
34-
BasisSQDTAlkalineJJ
35-
BasisSQDTAlkalineFJ
36-
37-
**Angular module**
38-
39-
.. autosummary::
40-
:toctree: _autosummary/
41-
42-
angular.AngularKetLS
43-
angular.AngularKetJJ
44-
angular.AngularKetFJ
45-
angular.AngularState
46-
angular.utils
47-
48-
49-
**Radial module**
50-
51-
.. autosummary::
52-
:toctree: _autosummary/
53-
54-
radial.RadialKet
55-
radial.Wavefunction
56-
radial.Model
57-
radial.numerov
58-
59-
**Species module and parameters**
60-
61-
.. autosummary::
62-
:toctree: _autosummary/
63-
64-
species.SpeciesObjectSQDT
65-
species.HydrogenTextBook
66-
species.Hydrogen
67-
species.Lithium
68-
species.Sodium
69-
species.Potassium
70-
species.Rubidium
71-
species.Cesium
72-
species.Strontium87
73-
species.Strontium88
74-
species.Ytterbium171
75-
species.Ytterbium173
76-
species.Ytterbium174
14+
.. toctree::
15+
:maxdepth: 2
16+
17+
api/rydberg_states
18+
api/basis
19+
api/angular
20+
api/radial
21+
api/species_sqdt
22+
api/species_mqdt

‎docs/conf.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@
3636

3737
# -- Options for HTML output -------------------------------------------------
3838
html_theme = "sphinx_rtd_theme"
39+
html_theme_options = {
40+
"collapse_navigation": False,
41+
"navigation_depth": 3,
42+
}
3943
html_static_path = ["_static"]
4044

4145

0 commit comments

Comments
 (0)