Merge pull request #189 from dtscalibration/prepare-for-v3.0.0

Prepare for v3.0.0
dtscalibration · Aug 8, 2023 · 926231f · 926231f
2 parents e9d0611 + 9b1fae2
commit 926231f
Show file tree

Hide file tree

Showing 40 changed files with 5,311 additions and 5,386 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -12,12 +12,16 @@ Added
 Fixed
 
 * Single-ended measurements with `fix_alpha` failed due to a bug introduced in v2.0.0 ([#173](https://github.com/dtscalibration/python-dts-calibration/pull/173)).
+* Headers in example notebooks and their appearance in the docs are now at correct levels
 
 Changed
 
 * Standardized parameter names. Reduced the freedom in choosing parameter names and dimension names in favor of simplifying the code.
 * Requiring netcdf4 >= 1.6.4
 * Optional dependencies of xarray that improve performance are now required by default.
+* variance_stokes_linear() does not default through zero anymore.
+* Refactored calibration_single_ended and calibration_double_ended()
+* Moved ParameterIndices classes to calibration_utils.py
 * Flox included in requirements to speed up resampling via xarray ([Xarray #5734](https://github.com/pydata/xarray/pull/5734)).
 
 Removed

diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/api/dtscalibration.DataStore.rst b/docs/api/dtscalibration.DataStore.rst
diff --git a/docs/api/dtscalibration.check_dims.rst b/docs/api/dtscalibration.check_dims.rst
diff --git a/docs/api/dtscalibration.check_timestep_allclose.rst b/docs/api/dtscalibration.check_timestep_allclose.rst
diff --git a/docs/api/dtscalibration.get_netcdf_encoding.rst b/docs/api/dtscalibration.get_netcdf_encoding.rst
diff --git a/docs/api/dtscalibration.merge_double_ended.rst b/docs/api/dtscalibration.merge_double_ended.rst
diff --git a/docs/api/dtscalibration.open_datastore.rst b/docs/api/dtscalibration.open_datastore.rst
diff --git a/docs/api/dtscalibration.open_mf_datastore.rst b/docs/api/dtscalibration.open_mf_datastore.rst
diff --git a/docs/api/dtscalibration.plot_accuracy.rst b/docs/api/dtscalibration.plot_accuracy.rst
diff --git a/docs/api/dtscalibration.plot_location_residuals_double_ended.rst b/docs/api/dtscalibration.plot_location_residuals_double_ended.rst
diff --git a/docs/api/dtscalibration.plot_residuals_reference_sections.rst b/docs/api/dtscalibration.plot_residuals_reference_sections.rst
diff --git a/docs/api/dtscalibration.plot_residuals_reference_sections_single.rst b/docs/api/dtscalibration.plot_residuals_reference_sections_single.rst
diff --git a/docs/api/dtscalibration.plot_sigma_report.rst b/docs/api/dtscalibration.plot_sigma_report.rst
diff --git a/docs/api/dtscalibration.read_apsensing_files.rst b/docs/api/dtscalibration.read_apsensing_files.rst
diff --git a/docs/api/dtscalibration.read_sensornet_files.rst b/docs/api/dtscalibration.read_sensornet_files.rst
diff --git a/docs/api/dtscalibration.read_sensortran_files.rst b/docs/api/dtscalibration.read_sensortran_files.rst
diff --git a/docs/api/dtscalibration.read_silixa_files.rst b/docs/api/dtscalibration.read_silixa_files.rst
diff --git a/docs/api/dtscalibration.shift_double_ended.rst b/docs/api/dtscalibration.shift_double_ended.rst
diff --git a/docs/api/dtscalibration.suggest_cable_shift_double_ended.rst b/docs/api/dtscalibration.suggest_cable_shift_double_ended.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,6 +4,7 @@
 
 
 extensions = [
+    "sphinx_rtd_theme",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.coverage",
@@ -69,7 +70,7 @@
 napoleon_use_param = False
 
 # sphinx_automodapi.automodapi
-numpydoc_show_class_members = False
+numpydoc_show_class_members = True
 
 # -- nbsphinx configuration --
 nbsphinx_allow_errors = False

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,11 +3,9 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    readme
-   installation
-   usage
    learn_by_examples
    reference/index
    contributing

diff --git a/docs/installation.rst b/docs/installation.rst
diff --git a/docs/nb_examples_to_docs.py b/docs/nb_examples_to_docs.py