diff options
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 |