docs: reorganize documentation (#171)

docs/_static/custom.css

@@ -33,4 +33,11 @@ div.admonition.info > .admonition-title:before {
 }
 div.admonition.info > .admonition-title:after {
  color: #f9d264;
+}
+
+/* Class for centering elements */
+.center h1 { text-align: center; }
+.main-container .navbar-brand {
+ justify-content: center;
+ flex: 1;
 }

docs/api_reference/_autosummary/xeofs.models.CCA.rst

@@ -0,0 +1,39 @@
+xeofs.models.CCA
+================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: CCA
+ :members:
+ :show-inheritance: 
+ :inherited-members:
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~CCA.__init__
+ ~CCA.components
+ ~CCA.explained_covariance
+ ~CCA.explained_covariance_ratio
+ ~CCA.explained_variance
+ ~CCA.explained_variance_ratio
+ ~CCA.fit
+ ~CCA.get_metadata_routing
+ ~CCA.get_params
+ ~CCA.scores
+ ~CCA.set_fit_request
+ ~CCA.set_params
+ ~CCA.set_transform_request
+ ~CCA.transform
+ ~CCA.weights
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.ComplexEOF.rst

@@ -0,0 +1,45 @@
+xeofs.models.ComplexEOF
+=======================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: ComplexEOF
+ :members:
+ :show-inheritance: 
+ :inherited-members:
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ComplexEOF.__init__
+ ~ComplexEOF.components
+ ~ComplexEOF.components_amplitude
+ ~ComplexEOF.components_phase
+ ~ComplexEOF.compute
+ ~ComplexEOF.deserialize
+ ~ComplexEOF.explained_variance
+ ~ComplexEOF.explained_variance_ratio
+ ~ComplexEOF.fit
+ ~ComplexEOF.fit_transform
+ ~ComplexEOF.get_params
+ ~ComplexEOF.get_serialization_attrs
+ ~ComplexEOF.inverse_transform
+ ~ComplexEOF.load
+ ~ComplexEOF.save
+ ~ComplexEOF.scores
+ ~ComplexEOF.scores_amplitude
+ ~ComplexEOF.scores_phase
+ ~ComplexEOF.serialize
+ ~ComplexEOF.singular_values
+ ~ComplexEOF.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.ComplexEOFRotator.rst

@@ -0,0 +1,45 @@
+xeofs.models.ComplexEOFRotator
+==============================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: ComplexEOFRotator
+ :members:
+ :show-inheritance: 
+ :inherited-members:
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ComplexEOFRotator.__init__
+ ~ComplexEOFRotator.components
+ ~ComplexEOFRotator.components_amplitude
+ ~ComplexEOFRotator.components_phase
+ ~ComplexEOFRotator.compute
+ ~ComplexEOFRotator.deserialize
+ ~ComplexEOFRotator.explained_variance
+ ~ComplexEOFRotator.explained_variance_ratio
+ ~ComplexEOFRotator.fit
+ ~ComplexEOFRotator.fit_transform
+ ~ComplexEOFRotator.get_params
+ ~ComplexEOFRotator.get_serialization_attrs
+ ~ComplexEOFRotator.inverse_transform
+ ~ComplexEOFRotator.load
+ ~ComplexEOFRotator.save
+ ~ComplexEOFRotator.scores
+ ~ComplexEOFRotator.scores_amplitude
+ ~ComplexEOFRotator.scores_phase
+ ~ComplexEOFRotator.serialize
+ ~ComplexEOFRotator.singular_values
+ ~ComplexEOFRotator.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.ComplexMCA.rst

@@ -0,0 +1,48 @@
+xeofs.models.ComplexMCA
+=======================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: ComplexMCA
+ :members:
+ :show-inheritance: 
+ :inherited-members:
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ComplexMCA.__init__
+ ~ComplexMCA.components
+ ~ComplexMCA.components_amplitude
+ ~ComplexMCA.components_phase
+ ~ComplexMCA.compute
+ ~ComplexMCA.covariance_fraction
+ ~ComplexMCA.deserialize
+ ~ComplexMCA.fit
+ ~ComplexMCA.get_params
+ ~ComplexMCA.get_serialization_attrs
+ ~ComplexMCA.heterogeneous_patterns
+ ~ComplexMCA.homogeneous_patterns
+ ~ComplexMCA.inverse_transform
+ ~ComplexMCA.load
+ ~ComplexMCA.save
+ ~ComplexMCA.scores
+ ~ComplexMCA.scores_amplitude
+ ~ComplexMCA.scores_phase
+ ~ComplexMCA.serialize
+ ~ComplexMCA.singular_values
+ ~ComplexMCA.squared_covariance
+ ~ComplexMCA.squared_covariance_fraction
+ ~ComplexMCA.total_covariance
+ ~ComplexMCA.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.ComplexMCARotator.rst

@@ -0,0 +1,48 @@
+xeofs.models.ComplexMCARotator
+==============================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: ComplexMCARotator
+ :members:
+ :show-inheritance: 
+ :inherited-members:
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~ComplexMCARotator.__init__
+ ~ComplexMCARotator.components
+ ~ComplexMCARotator.components_amplitude
+ ~ComplexMCARotator.components_phase
+ ~ComplexMCARotator.compute
+ ~ComplexMCARotator.covariance_fraction
+ ~ComplexMCARotator.deserialize
+ ~ComplexMCARotator.fit
+ ~ComplexMCARotator.get_params
+ ~ComplexMCARotator.get_serialization_attrs
+ ~ComplexMCARotator.heterogeneous_patterns
+ ~ComplexMCARotator.homogeneous_patterns
+ ~ComplexMCARotator.inverse_transform
+ ~ComplexMCARotator.load
+ ~ComplexMCARotator.save
+ ~ComplexMCARotator.scores
+ ~ComplexMCARotator.scores_amplitude
+ ~ComplexMCARotator.scores_phase
+ ~ComplexMCARotator.serialize
+ ~ComplexMCARotator.singular_values
+ ~ComplexMCARotator.squared_covariance
+ ~ComplexMCARotator.squared_covariance_fraction
+ ~ComplexMCARotator.total_covariance
+ ~ComplexMCARotator.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.EOF.rst

@@ -0,0 +1,41 @@
+xeofs.models.EOF
+================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: EOF
+ :members:
+ :show-inheritance: 
+ :inherited-members:
+
+
+ .. automethod:: __init__
+
+
+ .. rubric:: Methods
+
+ .. autosummary::
+
+ ~EOF.__init__
+ ~EOF.components
+ ~EOF.compute
+ ~EOF.deserialize
+ ~EOF.explained_variance
+ ~EOF.explained_variance_ratio
+ ~EOF.fit
+ ~EOF.fit_transform
+ ~EOF.get_params
+ ~EOF.get_serialization_attrs
+ ~EOF.inverse_transform
+ ~EOF.load
+ ~EOF.save
+ ~EOF.scores
+ ~EOF.serialize
+ ~EOF.singular_values
+ ~EOF.transform
+
+
+
+
+
+