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/api.rst | |
| parent | 4f27f75e2e3931b8a3c0529fc06f8e51bf3540b8 (diff) | |
| download | pyisda-88cfdd71041924a658785b0bdc84dbeffb144a96.tar.gz | |
round of improvements to the docs
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 17 |
1 files changed, 17 insertions, 0 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: |