24 add readthedoc

.github/workflows/build.yaml

@@ -5,6 +5,17 @@ on:
     tags: ["*"]
   pull_request:
 jobs:
+  docs:
+    name: docs
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.0.0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install tox
+      - run: tox -e docs
   tests:
     name: ${{ matrix.name }}
     runs-on: ubuntu-latest

.readthedocs.yaml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev
+    - requirements: requirements/dev.txt 

README.md

@@ -9,6 +9,7 @@
 [![codecov](https://codecov.io/gh/BuildingEnergySimulationTools/tide/branch/main/graph/badge.svg?token=F51O9CXI61)](https://codecov.io/gh/BuildingEnergySimulationTools/tide)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Documentation Status](https://readthedocs.org/projects/python-tide/badge/?version=latest)](https://python-tide.readthedocs.io/en/latest/?badge=latest)
 
 ## Pipeline Development and Data Visualization for Time Series in Physical Measurements
 
@@ -206,9 +207,9 @@ plumber.plot(
 </td>
 <td>
 The development of this library has been supported by ENSNARE Project, which
-has received funding from the European Union’s Horizon 2020 Research and Innovation
+has received funding from the European Union's Horizon 2020 Research and Innovation
 Programme under Grant Agreement No. 953193. The sole responsibility for the content of
-this library lies entirely with the author’s view. The European Commission is not
+this library lies entirely with the author's view. The European Commission is not
 responsible for any use that may be made of the information it contains. 
 </td>
 </tr>

docs/_static/custom.css

@@ -0,0 +1,8 @@
+.wy-side-nav-search .wy-side-nav-search > div.version {
+    margin-top: 0.5rem;
+}
+
+.wy-side-nav-search > a img.logo {
+    width: 100px;
+    height: auto;
+} 

docs/api_reference/classifiers.rst

@@ -0,0 +1,9 @@
+Classifiers Module
+=================
+
+The classifiers module provides classes for time series classification and pattern recognition.
+
+.. automodule:: tide.classifiers
+   :members:
+   :show-inheritance:
+   :exclude-members: _get_pipe_from_proc_list, _get_column_wise_transformer, _dummy_df 

docs/api_reference/index.rst

@@ -0,0 +1,14 @@
+API Reference
+============
+
+.. toctree::
+   :maxdepth: 2
+
+   plumbing
+   processing
+   regressor
+   classifiers
+   influx
+   metrics
+   meteo
+   plot 

docs/api_reference/influx.rst

@@ -0,0 +1,9 @@
+Influx Module
+============
+
+The influx module provides functionality for interacting with InfluxDB time series databases.
+
+.. automodule:: tide.influx
+   :members:
+   :show-inheritance:
+   :exclude-members: _get_pipe_from_proc_list, _get_column_wise_transformer, _dummy_df 

docs/api_reference/meteo.rst

@@ -0,0 +1,9 @@
+Meteo Module
+===========
+
+The meteo module provides functionality for handling meteorological data and calculations.
+
+.. automodule:: tide.meteo
+   :members:
+   :show-inheritance:
+   :exclude-members: _get_pipe_from_proc_list, _get_column_wise_transformer, _dummy_df 

docs/api_reference/metrics.rst

@@ -0,0 +1,9 @@
+Metrics Module
+=============
+
+The metrics module provides functions and classes for calculating various time series metrics and performance indicators.
+
+.. automodule:: tide.metrics
+   :members:
+   :show-inheritance:
+   :exclude-members: _get_pipe_from_proc_list, _get_column_wise_transformer, _dummy_df 

docs/api_reference/plumbing.rst

@@ -0,0 +1,23 @@
+Plumbing Module
+==============
+
+The plumbing module provides the core functionality for data pipeline creation and management.
+
+.. autoclass:: tide.plumbing.Plumber
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Pipeline Creation Functions
+-------------------------
+
+.. autofunction:: tide.plumbing._get_pipe_from_proc_list
+
+.. autofunction:: tide.plumbing._get_column_wise_transformer
+
+.. autofunction:: tide.plumbing.get_pipeline_from_dict
+
+Helper Functions
+--------------
+
+.. autofunction:: tide.plumbing._dummy_df 

docs/api_reference/processing.rst

@@ -0,0 +1,105 @@
+Processing Module
+================
+
+The processing module provides transformers for data processing and manipulation.
+
+.. autoclass:: tide.processing.Identity
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.Interpolate
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.Ffill
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.Bfill
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.ReplaceThreshold
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.DropTimeGradient
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.Resample
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.ExpressionCombine
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.ReplaceDuplicated
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.Dropna
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.RenameColumns
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.SkTransform
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.ApplyExpression
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.TimeGradient
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.AddTimeLag
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.CombineColumns
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.AddOikoData
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.AddSolarAngles
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.ProjectSolarRadOnSurfaces
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.FillOtherColumns
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.DropColumns
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.ReplaceTag
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.FillGapsAR
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.GaussianFilter1D
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.processing.STLFilter
+   :members:
+   :show-inheritance:
+

docs/api_reference/regressor.rst

@@ -0,0 +1,12 @@
+Regressor Module
+===============
+
+The regressor module provides classes for time series regression and forecasting.
+
+.. autoclass:: tide.regressors.SkSTLForecast
+   :members:
+   :show-inheritance:
+
+.. autoclass:: tide.regressors.SkProphet
+   :members:
+   :show-inheritance: 

docs/conf.py

@@ -0,0 +1,88 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+# Project information
+project = "python-tide"
+copyright = "2024, Baptiste Durand-Estebe"
+author = "Baptiste Durand-Estebe"
+
+# The full version, including alpha/beta/rc tags
+release = "0.1.4"
+
+# General configuration
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx_autodoc_typehints",
+    "myst_parser",
+    "nbsphinx",
+    "sphinx_copybutton",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The theme to use for HTML and HTML Help pages.
+html_theme = "sphinx_rtd_theme"
+
+# Theme options
+html_theme_options = {
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "style_nav_header_background": "#2980B9",
+    # Toc options
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
+    # GitHub link
+    "github_url": "https://github.com/bdurandestebe/tide",
+    "github_repo": "tide",
+    "github_user": "bdurandestebe",
+}
+
+# Add any paths that contain custom static files (such as style sheets)
+html_static_path = ["_static"]
+
+# Custom CSS
+html_css_files = [
+    "custom.css",
+]
+
+# Logo
+html_logo = "../tide_logo.svg"
+html_favicon = "../tide_logo.svg"
+
+# Napoleon settings
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = True
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_references = True
+napoleon_use_ivar = True
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_type_aliases = None
+
+# Autodoc settings
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+    "special-members": "__init__",
+    "undoc-members": True,
+    "exclude-members": "__weakref__",
+}