Fix docstrings formatting

zlatko-minev · Feb 21, 2022 · ccbd35e · ccbd35e
1 parent 3030b31
commit ccbd35e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 17 deletions.
diff --git a/pyEPR/calcs/back_box_numeric.py b/pyEPR/calcs/back_box_numeric.py
@@ -86,8 +86,8 @@ def black_box_hamiltonian(fs, ljs, fzpfs, cos_trunc=5, fock_trunc=8, individual=
     All in SI units. The ZPF fed in are the generalized, not reduced, flux.
 
     Description:
-     Takes the linear mode frequencies, $\omega_m$, and the zero-point fluctuations, ZPFs, and
-     builds the Hamiltonian matrix of $H_full$, assuming cos potential.
+     Takes the linear mode frequencies, :math:`\omega_m`, and the zero-point fluctuations, ZPFs, and
+     builds the Hamiltonian matrix of :math:`H_{full}`, assuming cos potential.
     """
     n_modes = len(fs)
     njuncs = len(ljs)

diff --git a/pyEPR/calcs/basic.py b/pyEPR/calcs/basic.py
@@ -11,8 +11,7 @@ class CalcsBasic():
     @staticmethod
     def epr_to_zpf(Pmj, SJ, Ω, EJ):
         r'''
-        INPUTS:
-            All as matrices (numpy arrays)
+        Arguments, All as matrices (numpy arrays):
             :Pnj: MxJ energy-participation-ratio matrix, p_mj
             :SJ: MxJ sign matrix, s_mj
             :Ω: MxM diagonal matrix of frequencies (GHz, not radians, diagonal)

diff --git a/pyEPR/calcs/convert.py b/pyEPR/calcs/convert.py
@@ -25,13 +25,13 @@ class Convert():
         Static container class for conversions of units and variables.
 
         TEST CONVERSION:
-        ```python
-            from pyEPR.toolbox.conversions import Convert
 
-            Lj_nH, Cs_fF = 11, 60
-            Convert.transmon_print_all_params(Lj_nH, Cs_fF);
+        .. code-block:: python
 
-        ```
+           from pyEPR.toolbox.conversions import Convert
+           
+           Lj_nH, Cs_fF = 11, 60
+           Convert.transmon_print_all_params(Lj_nH, Cs_fF);
     '''
     # Known SI prefixed
     _prefix = {'y': -24,  # yocto
@@ -109,7 +109,7 @@ def Ej_from_Lj(Lj, units_in='nH', units_out='MHz'):
         Josephson Junction energy from Josephson inductance.
         Returns in MHz
 
-        $E_j = \phi_0^2 / L_J$
+        :math:`E_j = \phi_0^2 / L_J`
         '''
         return Convert._convert_num(
             # Plank to go from Joules to Hz
@@ -122,7 +122,7 @@ def Lj_from_Ej(Ej, units_in='MHz', units_out='nH'):
         Josephson Junction ind from Josephson energy in MHZ.
         Returns in units of nano Henries by default
 
-        $E_j = \phi_0^2 / L_J$
+        :math:`E_j = \phi_0^2 / L_J`
         '''
         return Convert._convert_num(
             lambda _x: (ϕ0**2.)/(_x*Planck),  # Plank to go from Joules to Hz
@@ -133,7 +133,7 @@ def Ic_from_Lj(Lj, units_in='nH', units_out='nA'):
         r'''
         Josephson Junction crit. curr from Josephson inductance.
 
-        $E_j = \phi_0^2 / L_J = \phi_0 I_C $
+        :math:`E_j = \phi_0^2 / L_J = \phi_0 I_C`
         '''
         return Convert._convert_num(
             lambda _x: ϕ0/_x,  # Plank to go from Joules to Hz
@@ -144,7 +144,7 @@ def Lj_from_Ic(Lj, units_in='nA', units_out='nH'):
         r'''
         Josephson Junction crit. curr from Josephson inductance.
 
-        $E_j = \phi_0^2 / L_J = \phi_0 I_C $
+        :math:`E_j = \phi_0^2 / L_J = \phi_0 I_C`
         '''
         return Convert._convert_num(
             lambda _x: ϕ0/_x,  # Plank to go from Joules to Hz
@@ -153,10 +153,10 @@ def Lj_from_Ic(Lj, units_in='nA', units_out='nH'):
     @staticmethod
     def Ec_from_Cs(Cs,  units_in='fF', units_out='MHz'):
         r'''
-        Charging energy 4Ec n^2, where n=Q/2e
+        Charging energy :math:`4E_c n^2`, where :math:`n=Q/2e`
         Returns in MHz
 
-        $E_{C}=\frac{e^{2}}{2C}J$
+        :math:`E_{C}=\frac{e^{2}}{2C}J`
         '''
         return Convert._convert_num(
             # Plank to go from Joules to Hz
@@ -166,11 +166,11 @@ def Ec_from_Cs(Cs,  units_in='fF', units_out='MHz'):
     @staticmethod
     def Cs_from_Ec(Ec, units_in='MHz', units_out='fF'):
         r'''
-        Charging energy 4Ec n^2, where n=Q/2e
+        Charging energy :math:`4E_c n^2`, where :math:`n=Q/2e`
 
         Returns in SI units, in Farads.
 
-        $E_{C}=\frac{e^{2}}{2C}J$
+        :math:`E_{C}=\frac{e^{2}}{2C}J`
         '''
         return Convert._convert_num(
             # Plank to go from Joules to Hz