diff options
| author | Markus Holtermann <info@markusholtermann.eu> | 2013-02-20 03:42:03 +0100 |
|---|---|---|
| committer | Markus Holtermann <info@markusholtermann.eu> | 2013-02-20 03:44:32 +0100 |
| commit | c14fefa5b8635d030d2150a42a37894d035410bf (patch) | |
| tree | 0218771b5d59d64d12e31ed9023e7f978142873c /docs/source/ref/api.rst | |
| parent | 8511f9d5dfd8db9071235470145f6698bd1d69d9 (diff) | |
| download | bvg-grabber-c14fefa5b8635d030d2150a42a37894d035410bf.tar.gz bvg-grabber-c14fefa5b8635d030d2150a42a37894d035410bf.tar.bz2 bvg-grabber-c14fefa5b8635d030d2150a42a37894d035410bf.zip | |
Some docstring fixes along with a docs directory
Diffstat (limited to 'docs/source/ref/api.rst')
| -rw-r--r-- | docs/source/ref/api.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/source/ref/api.rst b/docs/source/ref/api.rst new file mode 100644 index 0000000..06c9c9e --- /dev/null +++ b/docs/source/ref/api.rst @@ -0,0 +1,33 @@ +=== +API +=== + +.. automodule:: bvggrabber.api + + +General Functions +================= + + .. autofunction:: compute_remaining + + +Base and Main Classes +===================== + + .. autoclass:: Departure + :members: __init__, remaining, __eq__, __lt__, __str__ + + .. autoclass:: QueryApi + :members: call + + .. autoclass:: Response + :members: merge, to_json, departures, error, json, state + + +Concrete Implementations +======================== + + .. toctree:: + api.actual + api.scheduled + :maxdepth: 1 |