BUGFIX in docs.

docs/source/conf.py

@@ -0,0 +1,32 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../'))
+
+project = 'DIESEL'
+copyright = '2024, Cédric Travelletti'
+author = 'Cédric Travelletti'
+release = '0.3'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,36 @@
+.. DIESEL documentation master file, created by
+   sphinx-quickstart on Sat Feb 10 14:43:25 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+DIESEL Documentation
+==================================
+
+DIESEL is an open source Python package for **DIstributed EStimation of large EnsembLe covariance matrices**.
+
+
+It uses distributed arrays (`DASK <https://www.dask.org/>`_) to allow handling very large 
+covariance matrices and provides distributed implementations of several covariance estimation algorithms. 
+
+
+See `this article <https://arxiv.org/abs/2311.12909>`_ for an example of how **DIESEL** can be leveraged to reconstruct the climate of the past on a global scale at high-resolution.
+
+.. toctree::
+   :maxdepth: 1
+
+   diesel.covariance
+   diesel.estimation
+   diesel.sampling
+   diesel.plotting
+   diesel.gridding
+
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`