fixing doc (#34)

Author: JoschD

doc/conf.py

@@ -98,7 +98,7 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

doc/helper/constants.rst

@@ -1,3 +1,4 @@
 .. automodule:: optics_functions.constants
     :members:
+    :noindex:
 

doc/index.rst

@@ -15,6 +15,7 @@ Package Reference
 
    modules/*
 
+
 .. toctree::
    :caption: Helper
    :maxdepth: 1

doc/modules/coupling.rst

@@ -1,4 +1,4 @@
 .. automodule:: optics_functions.coupling
     :members:
-
+    :noindex:
 

doc/modules/rdt.rst

@@ -1,4 +1,5 @@
 .. automodule:: optics_functions.rdt
     :members:
+    :noindex:
 
 

doc/modules/utils.rst

@@ -1,4 +1,4 @@
 .. automodule:: optics_functions.utils
     :members:
-
+    :noindex:
 

optics_functions/coupling.py

@@ -135,7 +135,7 @@ def coupling_via_cmatrix(df: DataFrame, complex_columns: bool = True,
 
 def rmatrix_from_coupling(df: DataFrame, complex_columns: bool = True) -> DataFrame:
     """Calculates the R-matrix from a DataFrame containing the coupling columns
-     as well as alpha and beta columns. This is the inverse of
+    as well as alpha and beta columns. This is the inverse of
     :func:`optics_functions.coupling.coupling_via_cmatrix`.
     See [CalagaBetatronCoupling2005]_ .
 
@@ -349,7 +349,7 @@ def _get_weights_from_lengths(df: TfsDataFrame) -> Tuple[float, np.array]:
 
 
 def check_resonance_relation(df: DataFrame, to_nan: bool = False) -> DataFrame:
-    """Checks that |F1001| >= |F1010|.
+    """Checks that \|F1001| >= \|F1010|.
     If desired, sets the invalid points to NaN. This is only used for checking
     in the :func:`~optics_functions.coupling.closest_tune_approach` function,
     but can be invoked by the user with ``to_nan = True`` and the resulting
@@ -358,7 +358,7 @@ def check_resonance_relation(df: DataFrame, to_nan: bool = False) -> DataFrame:
 
     Args:
         df (DataFrame): Dataframe containing the coupling columns.
-        to_nan (bool): If true, sets values where |F1001| <= |F1010| to ``NaN``.
+        to_nan (bool): If true, sets values where \|F1001| <= \|F1010| to ``NaN``.
 
     Returns:
         A copy of the input data frame, with or without NaNs.