diff options
| author | Guillaume Horel <guillaume.horel@serenitascapital.com> | 2016-08-03 13:51:45 -0400 |
|---|---|---|
| committer | Guillaume Horel <guillaume.horel@serenitascapital.com> | 2016-08-03 13:51:45 -0400 |
| commit | 88cfdd71041924a658785b0bdc84dbeffb144a96 (patch) | |
| tree | 879b580de01df6811dee7971c1a9fa988ca504f8 /docs | |
| parent | 4f27f75e2e3931b8a3c0529fc06f8e51bf3540b8 (diff) | |
| download | pyisda-88cfdd71041924a658785b0bdc84dbeffb144a96.tar.gz | |
round of improvements to the docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 17 | ||||
| -rw-r--r-- | docs/conf.py | 5 |
2 files changed, 20 insertions, 2 deletions
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 |