diff --git a/docs/conf.py b/docs/conf.py index 6e28eadd..6ef238c1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,6 +2,9 @@ from datetime import date import os +from dtscalibration.dts_accessor import DtsAccessor # noqa: E402 +import sphinx_autosummary_accessors + extensions = [ "sphinx_rtd_theme", @@ -15,6 +18,7 @@ "sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autosectionlabel", + "sphinx_autosummary_accessors", "nbsphinx", "sphinx.ext.mathjax", "sphinx.ext.intersphinx", @@ -45,7 +49,7 @@ version = release = "2.0.0" pygments_style = "trac" -templates_path = ["."] +templates_path = [".", sphinx_autosummary_accessors.templates_path] extlinks = { "issue": ( "https://github.com/dtscalibration/python-dts-calibration/issues" "/%s", diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 9d9e4821..a8df48bd 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -1,10 +1,44 @@ Reference ========= -.. toctree:: - :glob: +Load the data +------------- -.. automodapi:: dtscalibration - :skip: plot_dask +.. automodule:: dtscalibration.io :members: - :no-inheritance-diagram: + :nosignatures: + +Compute the variance in the Stokes measurements +----------------------------------------------- + +.. automodule:: dtscalibration.variance_stokes + :members: + :nosignatures: + +The DTS Accessor +---------------- + +.. currentmodule:: xarray +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_method.rst + :nosignatures: + + Dataset.dts.sections + Dataset.dts.calibrate_single_ended + Dataset.dts.calibrate_double_ended + Dataset.dts.monte_carlo_single_ended + Dataset.dts.monte_carlo_double_ended + Dataset.dts.average_monte_carlo_single_ended + Dataset.dts.average_monte_carlo_double_ended + Dataset.dts.get_default_encoding + Dataset.dts.get_timeseries_keys + Dataset.dts.matching_sections + Dataset.dts.ufunc_per_section + +Plot the results +---------------- + +.. automodule:: dtscalibration.plot + :members: + :nosignatures: \ No newline at end of file