fixed api documentation

BlackHolePerturbationToolkit · Sep 5, 2023 · 1fcee22 · 1fcee22
1 parent 20eb66a
commit 1fcee22
Show file tree

Hide file tree

Showing 60 changed files with 774 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -70,7 +70,6 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-_autosummary/
 
 # PyBuilder
 .pybuilder/

diff --git a/docs/source/_autosummary/kerrgeopy.bound_orbit.BoundOrbit.rst b/docs/source/_autosummary/kerrgeopy.bound_orbit.BoundOrbit.rst
@@ -0,0 +1,32 @@
+BoundOrbit
+==========
+
+.. currentmodule:: kerrgeopy.bound_orbit
+
+.. autoclass:: BoundOrbit
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BoundOrbit.__init__
+      ~BoundOrbit.animate
+      ~BoundOrbit.constants_of_motion
+      ~BoundOrbit.is_visible
+      ~BoundOrbit.mino_frequencies
+      ~BoundOrbit.observer_frequencies
+      ~BoundOrbit.plot
+      ~BoundOrbit.trajectory
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/kerrgeopy.bound_orbit.rst b/docs/source/_autosummary/kerrgeopy.bound_orbit.rst
@@ -0,0 +1,31 @@
+bound\_orbit
+============
+
+.. automodule:: kerrgeopy.bound_orbit
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      BoundOrbit
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/kerrgeopy.bound_solutions.polar_solutions.rst b/docs/source/_autosummary/kerrgeopy.bound_solutions.polar_solutions.rst
@@ -0,0 +1,6 @@
+polar\_solutions
+================
+
+.. currentmodule:: kerrgeopy.bound_solutions
+
+.. autofunction:: polar_solutions
diff --git a/docs/source/_autosummary/kerrgeopy.bound_solutions.radial_solutions.rst b/docs/source/_autosummary/kerrgeopy.bound_solutions.radial_solutions.rst
@@ -0,0 +1,6 @@
+radial\_solutions
+=================
+
+.. currentmodule:: kerrgeopy.bound_solutions
+
+.. autofunction:: radial_solutions
diff --git a/docs/source/_autosummary/kerrgeopy.bound_solutions.rst b/docs/source/_autosummary/kerrgeopy.bound_solutions.rst
@@ -0,0 +1,32 @@
+bound\_solutions
+================
+
+.. automodule:: kerrgeopy.bound_solutions
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :template: custom-base-template.rst
+
+      polar_solutions
+      radial_solutions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/kerrgeopy.constants.angular_momentum.rst b/docs/source/_autosummary/kerrgeopy.constants.angular_momentum.rst
@@ -0,0 +1,6 @@
+angular\_momentum
+=================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: angular_momentum
diff --git a/docs/source/_autosummary/kerrgeopy.constants.carter_constant.rst b/docs/source/_autosummary/kerrgeopy.constants.carter_constant.rst
@@ -0,0 +1,6 @@
+carter\_constant
+================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: carter_constant
diff --git a/docs/source/_autosummary/kerrgeopy.constants.constants_of_motion.rst b/docs/source/_autosummary/kerrgeopy.constants.constants_of_motion.rst
@@ -0,0 +1,6 @@
+constants\_of\_motion
+=====================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: constants_of_motion
diff --git a/docs/source/_autosummary/kerrgeopy.constants.energy.rst b/docs/source/_autosummary/kerrgeopy.constants.energy.rst
@@ -0,0 +1,6 @@
+energy
+======
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: energy
diff --git a/docs/source/_autosummary/kerrgeopy.constants.fast_separatrix.rst b/docs/source/_autosummary/kerrgeopy.constants.fast_separatrix.rst
@@ -0,0 +1,6 @@
+fast\_separatrix
+================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: fast_separatrix
diff --git a/docs/source/_autosummary/kerrgeopy.constants.is_stable.rst b/docs/source/_autosummary/kerrgeopy.constants.is_stable.rst
@@ -0,0 +1,6 @@
+is\_stable
+==========
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: is_stable
diff --git a/docs/source/_autosummary/kerrgeopy.constants.rst b/docs/source/_autosummary/kerrgeopy.constants.rst
@@ -0,0 +1,39 @@
+constants
+=========
+
+.. automodule:: kerrgeopy.constants
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :template: custom-base-template.rst
+
+      angular_momentum
+      carter_constant
+      constants_of_motion
+      energy
+      fast_separatrix
+      is_stable
+      scale_constants
+      separatrix
+      valid_params
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/kerrgeopy.constants.scale_constants.rst b/docs/source/_autosummary/kerrgeopy.constants.scale_constants.rst
@@ -0,0 +1,6 @@
+scale\_constants
+================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: scale_constants
diff --git a/docs/source/_autosummary/kerrgeopy.constants.separatrix.rst b/docs/source/_autosummary/kerrgeopy.constants.separatrix.rst
@@ -0,0 +1,6 @@
+separatrix
+==========
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: separatrix
diff --git a/docs/source/_autosummary/kerrgeopy.constants.valid_params.rst b/docs/source/_autosummary/kerrgeopy.constants.valid_params.rst
@@ -0,0 +1,6 @@
+valid\_params
+=============
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: valid_params
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.gamma.rst b/docs/source/_autosummary/kerrgeopy.frequencies.gamma.rst
@@ -0,0 +1,6 @@
+gamma
+=====
+
+.. currentmodule:: kerrgeopy.frequencies
+
+.. autofunction:: gamma
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.mino_frequencies.rst b/docs/source/_autosummary/kerrgeopy.frequencies.mino_frequencies.rst
@@ -0,0 +1,6 @@
+mino\_frequencies
+=================
+
+.. currentmodule:: kerrgeopy.frequencies
+
+.. autofunction:: mino_frequencies
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.observer_frequencies.rst b/docs/source/_autosummary/kerrgeopy.frequencies.observer_frequencies.rst
@@ -0,0 +1,6 @@
+observer\_frequencies
+=====================
+
+.. currentmodule:: kerrgeopy.frequencies
+
+.. autofunction:: observer_frequencies
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.phi_frequency.rst b/docs/source/_autosummary/kerrgeopy.frequencies.phi_frequency.rst
@@ -0,0 +1,6 @@
+phi\_frequency
+==============
+
+.. currentmodule:: kerrgeopy.frequencies
+
+.. autofunction:: phi_frequency
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.r_frequency.rst b/docs/source/_autosummary/kerrgeopy.frequencies.r_frequency.rst
@@ -0,0 +1,6 @@
+r\_frequency
+============
+
+.. currentmodule:: kerrgeopy.frequencies
+
+.. autofunction:: r_frequency
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.rst b/docs/source/_autosummary/kerrgeopy.frequencies.rst
@@ -0,0 +1,36 @@
+frequencies
+===========
+
+.. automodule:: kerrgeopy.frequencies
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :template: custom-base-template.rst
+
+      gamma
+      mino_frequencies
+      observer_frequencies
+      phi_frequency
+      r_frequency
+      theta_frequency
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.theta_frequency.rst b/docs/source/_autosummary/kerrgeopy.frequencies.theta_frequency.rst
@@ -0,0 +1,6 @@
+theta\_frequency
+================
+
+.. currentmodule:: kerrgeopy.frequencies
+
+.. autofunction:: theta_frequency
diff --git a/...urce/_autosummary/kerrgeopy.frequencies_from_constants.gamma_from_constants.rst b/...urce/_autosummary/kerrgeopy.frequencies_from_constants.gamma_from_constants.rst
@@ -0,0 +1,6 @@
+gamma\_from\_constants
+======================
+
+.. currentmodule:: kerrgeopy.frequencies_from_constants
+
+.. autofunction:: gamma_from_constants
diff --git a/...ummary/kerrgeopy.frequencies_from_constants.mino_frequencies_from_constants.rst b/...ummary/kerrgeopy.frequencies_from_constants.mino_frequencies_from_constants.rst
@@ -0,0 +1,6 @@
+mino\_frequencies\_from\_constants
+==================================
+
+.. currentmodule:: kerrgeopy.frequencies_from_constants
+
+.. autofunction:: mino_frequencies_from_constants
diff --git a/...ry/kerrgeopy.frequencies_from_constants.observer_frequencies_from_constants.rst b/...ry/kerrgeopy.frequencies_from_constants.observer_frequencies_from_constants.rst
@@ -0,0 +1,6 @@
+observer\_frequencies\_from\_constants
+======================================
+
+.. currentmodule:: kerrgeopy.frequencies_from_constants
+
+.. autofunction:: observer_frequencies_from_constants
diff --git a/...tosummary/kerrgeopy.frequencies_from_constants.phi_frequency_from_constants.rst b/...tosummary/kerrgeopy.frequencies_from_constants.phi_frequency_from_constants.rst
@@ -0,0 +1,6 @@
+phi\_frequency\_from\_constants
+===============================
+
+.. currentmodule:: kerrgeopy.frequencies_from_constants
+
+.. autofunction:: phi_frequency_from_constants
diff --git a/...autosummary/kerrgeopy.frequencies_from_constants.r_frequency_from_constants.rst b/...autosummary/kerrgeopy.frequencies_from_constants.r_frequency_from_constants.rst
@@ -0,0 +1,6 @@
+r\_frequency\_from\_constants
+=============================
+
+.. currentmodule:: kerrgeopy.frequencies_from_constants
+
+.. autofunction:: r_frequency_from_constants
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies_from_constants.rst b/docs/source/_autosummary/kerrgeopy.frequencies_from_constants.rst
@@ -0,0 +1,36 @@
+frequencies\_from\_constants
+============================
+
+.. automodule:: kerrgeopy.frequencies_from_constants
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+      :template: custom-base-template.rst
+
+      gamma_from_constants
+      mino_frequencies_from_constants
+      observer_frequencies_from_constants
+      phi_frequency_from_constants
+      r_frequency_from_constants
+      theta_frequency_from_constants
+
+
+
+
+
+
+
+
+
+
+
+
+