Update documentation

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2116aff26f83ec397cc5d8b9f9612df7
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api/data/index.rst

@@ -0,0 +1,6 @@
+==============
+Data fetching
+==============
+
+.. currentmodule:: quantflow.data
+

_sources/api/index.rst

@@ -0,0 +1,40 @@
+
+API Reference
+==============
+
+.. grid::
+
+    .. grid-item-card::
+
+        .. toctree::
+           :maxdepth: 2
+
+           sp/index
+
+    .. grid-item-card::
+
+        .. toctree::
+           :maxdepth: 2
+
+           options/index
+    .. grid-item-card::
+
+        .. toctree::
+           :maxdepth: 2
+
+           ta/index
+.. grid::
+
+    .. grid-item-card::
+
+        .. toctree::
+           :maxdepth: 2
+
+           data/index
+
+    .. grid-item-card::
+
+        .. toctree::
+           :maxdepth: 2
+
+           utils/index

_sources/api/options/index.rst

@@ -0,0 +1,10 @@
+==================================
+Option Pricing
+==================================
+
+.. currentmodule:: quantflow.options
+
+.. toctree::
+    :maxdepth: 1
+
+    vol_surface

_sources/api/options/vol_surface.rst

@@ -0,0 +1,8 @@
+==================================
+VolSurface
+==================================
+
+.. module:: quantflow.options.surface
+
+.. autoclass:: VolSurface
+   :members:

_sources/api/sp/cir.rst

@@ -0,0 +1,10 @@
+================
+CIR
+================
+
+The Cox–Ingersoll–Ross (CIR) model
+
+.. currentmodule:: quantflow.sp.cir
+
+.. autoclass:: CIR
+   :members:

_sources/api/sp/compound_poisson.rst

@@ -0,0 +1,8 @@
+===================
+Compound Poisson
+===================
+
+.. currentmodule:: quantflow.sp.poisson
+
+.. autoclass:: CompoundPoissonProcess
+   :members:

_sources/api/sp/heston.rst

@@ -0,0 +1,8 @@
+================
+Heston process
+================
+
+.. currentmodule:: quantflow.sp.heston
+
+.. autoclass:: Heston
+   :members:

_sources/api/sp/index.rst

@@ -0,0 +1,35 @@
+===================
+Stochastic Process
+===================
+
+This page gives an overview of all Stochastic Processes available in the library.
+
+.. _sp:
+
+.. currentmodule:: quantflow.sp.base
+
+.. autoclass:: StochasticProcess
+    :members:
+    :noindex:
+    :autosummary:
+    :autosummary-nosignatures:
+
+.. autoclass:: StochasticProcess1D
+    :members:
+    :noindex:
+
+
+.. autoclass:: IntensityProcess
+    :members:
+    :noindex:
+
+.. toctree::
+    :maxdepth: 1
+
+    weiner
+    poisson
+    compound_poisson
+    ou
+    cir
+    jump_diffusion
+    heston

_sources/api/sp/jump_diffusion.rst

@@ -0,0 +1,17 @@
+================
+Jump diffusions
+================
+
+Jump-diffusions models are a class of stochastic processes that combine a diffusion process with a jump process. The jump process is a Poisson process that generates jumps in the value of the underlying asset. The jump-diffusion model is a generalization of the Black-Scholes model that allows for the possibility of large,
+discontinuous jumps in the value of the underlying asset.
+
+The most famous jump-diffusion model is the Merton model, which was introduced by Robert Merton in 1976. The Merton model assumes that the underlying asset follows a geometric Brownian motion with jumps that are normally distributed.
+
+.. currentmodule:: quantflow.sp.jump_diffusion
+
+.. autoclass:: JumpDiffusion
+   :members:
+
+
+.. autoclass:: Merton
+   :members:

_sources/api/sp/ou.rst

@@ -0,0 +1,16 @@
+================
+OU Processes
+================
+
+These are the classes that implement gaussian and non-gaussian
+`Ornstein-Uhlenbeck <https://en.wikipedia.org/wiki/Ornstein%E2%80%93Uhlenbeck_process>` process.
+
+
+.. currentmodule:: quantflow.sp.ou
+
+.. autoclass:: Vasicek
+   :members:
+
+
+.. autoclass:: GammaOU
+   :members:

_sources/api/sp/poisson.rst

@@ -0,0 +1,8 @@
+================
+Poisson process
+================
+
+.. currentmodule:: quantflow.sp.poisson
+
+.. autoclass:: PoissonProcess
+   :members:

_sources/api/sp/weiner.rst

@@ -0,0 +1,8 @@
+===============
+Weiner process
+===============
+
+.. module:: quantflow.sp.weiner
+
+.. autoclass:: WeinerProcess
+   :members:

_sources/api/ta/index.rst

@@ -0,0 +1,10 @@
+==================================
+Timeseries Analysis
+==================================
+
+.. currentmodule:: quantflow.ta
+
+.. toctree::
+    :maxdepth: 1
+
+    ohlc

_sources/api/ta/ohlc.rst

@@ -0,0 +1,12 @@
+================
+OHLC
+================
+
+.. currentmodule:: quantflow.ta.ohlc
+
+.. autoclass:: OHLC
+   :members:
+   :member-order: groupwise
+   :member-order: groupwise
+   :autosummary:
+   :autosummary-nosignatures:

_sources/api/utils/index.rst

@@ -0,0 +1,11 @@
+======
+Utils
+======
+
+.. currentmodule:: quantflow.utils
+
+.. toctree::
+    :maxdepth: 1
+
+    paths
+    marginal1d

_sources/api/utils/marginal1d.rst

@@ -0,0 +1,11 @@
+===========
+Marginal1D
+===========
+
+.. module:: quantflow.utils.marginal
+
+.. autoclass:: Marginal1D
+   :members:
+   :member-order: groupwise
+   :autosummary:
+   :autosummary-nosignatures:

_sources/api/utils/paths.rst

@@ -0,0 +1,11 @@
+===========
+Paths
+===========
+
+.. module:: quantflow.utils.paths
+
+.. autoclass:: Paths
+   :members:
+   :member-order: groupwise
+   :autosummary:
+   :autosummary-nosignatures: