Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bdestombe committed Oct 27, 2023
1 parent 4da18d7 commit 1f40022
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 6 deletions.
6 changes: 5 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -15,6 +18,7 @@
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx_autosummary_accessors",
"nbsphinx",
"sphinx.ext.mathjax",
"sphinx.ext.intersphinx",
Expand Down Expand Up @@ -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",
Expand Down
44 changes: 39 additions & 5 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit 1f40022

Please sign in to comment.