Restructure docs

Author: lsbardel

notebooks/_config.yml

@@ -9,6 +9,7 @@ logo: assets/quantflow-light.svg
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
 execute:
+  #execute_notebooks: "off"
   execute_notebooks: force
 
 # Define the name of the latex output file for PDF builds
@@ -45,6 +46,7 @@ parse:
     - amsmath
 
 sphinx:
+  recursive_update: true
   config:
     html_js_files:
     # required by plotly charts
@@ -54,5 +56,9 @@ sphinx:
     }
   extra_extensions:
     - "sphinx.ext.autodoc"
-    # TODO: enable once we use sphinx 7
-    # - "sphinx_autodoc_typehints"
+    - "sphinx_autodoc_typehints"
+    - "sphinx.ext.autosummary"
+    - "sphinx.ext.intersphinx"
+    - "sphinx_autosummary_accessors"
+    - "sphinx_copybutton"
+    - "autodocsumm"

notebooks/_toc.yml

@@ -36,9 +36,7 @@ parts:
     - file: examples/poisson_sampling
     - file: examples/heston_vol_surface
 
-  - file: api/overview.rst
-    sections:
-    - file: api/sp.rst
+  - file: api/index.rst
 
 - caption: Reference
   chapters:

notebooks/api/data/index.rst

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

notebooks/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

notebooks/api/options/index.rst

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

notebooks/api/options.rst notebooks/api/options/vol_surface.rstnotebooks/api/options.rst renamed to notebooks/api/options/vol_surface.rst

@@ -1,10 +1,6 @@
 ==================================
-Options Calibration and Pricing
-==================================
-
-
 VolSurface
-==================
+==================================
 
 .. module:: quantflow.options.surface
 

notebooks/api/overview.rst

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

notebooks/api/sp.rst

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