From c14fefa5b8635d030d2150a42a37894d035410bf Mon Sep 17 00:00:00 2001
From: Markus Holtermann <info@markusholtermann.eu>
Date: Wed, 20 Feb 2013 03:42:03 +0100
Subject: Some docstring fixes along with a docs directory

---
 docs/source/ref/api.rst | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 docs/source/ref/api.rst

(limited to 'docs/source/ref/api.rst')

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
-- 
cgit v1.2.3