From 88cfdd71041924a658785b0bdc84dbeffb144a96 Mon Sep 17 00:00:00 2001
From: Guillaume Horel <guillaume.horel@serenitascapital.com>
Date: Wed, 3 Aug 2016 13:51:45 -0400
Subject: round of improvements to the docs

---
 docs/api.rst | 17 +++++++++++++++++
 docs/conf.py |  5 +++--
 2 files changed, 20 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/api.rst b/docs/api.rst
index e850f45..253ddd5 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,6 +1,23 @@
 PyISDA
 ======
 
+:mod:`~pyisda.cdsone` contains the two work horse functions of the library,
+which allow to convert back and forth from upfront to spread
+
+.. autosummary::
+    pyisda.cdsone.upfront_charge
+    pyisda.cdsone.spread_from_upfront
+
+.. automodule:: pyisda.cdsone
+    :members:
+
+:mod:`~pyisda.curve` contains two types of curves:
+
+.. autosummary::
+    pyisda.curve.YieldCurve
+    pyisda.curve.SpreadCurve
+
+
 .. automodule:: pyisda.curve
     :members:
     :undoc-members:
diff --git a/docs/conf.py b/docs/conf.py
index 855d662..5bdd422 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -34,7 +34,8 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.imgmath',
-    'sphinx.ext.napoleon'
+    'sphinx.ext.napoleon',
+    'sphinx.ext.autosummary'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -125,7 +126,7 @@ todo_include_todos = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
-- 
cgit v1.2.3-70-g09d2