From c14fefa5b8635d030d2150a42a37894d035410bf Mon Sep 17 00:00:00 2001 From: Markus Holtermann Date: Wed, 20 Feb 2013 03:42:03 +0100 Subject: Some docstring fixes along with a docs directory --- docs/source/index.rst | 24 ++++++++++++++++++++++++ docs/source/ref/api.actual.rst | 12 ++++++++++++ docs/source/ref/api.rst | 33 +++++++++++++++++++++++++++++++++ docs/source/ref/api.scheduled.rst | 21 +++++++++++++++++++++ docs/source/ref/utils.format.rst | 24 ++++++++++++++++++++++++ docs/source/ref/utils.json.rst | 18 ++++++++++++++++++ docs/source/ref/utils.rst | 10 ++++++++++ 7 files changed, 142 insertions(+) create mode 100644 docs/source/index.rst create mode 100644 docs/source/ref/api.actual.rst create mode 100644 docs/source/ref/api.rst create mode 100644 docs/source/ref/api.scheduled.rst create mode 100644 docs/source/ref/utils.format.rst create mode 100644 docs/source/ref/utils.json.rst create mode 100644 docs/source/ref/utils.rst (limited to 'docs/source') diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..090a43d --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,24 @@ +.. BVG-Grabber documentation master file, created by + sphinx-quickstart on Wed Feb 20 01:41:10 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to BVG-Grabber's documentation! +======================================= + +Contents: + +.. toctree:: + ref/api + ref/utils + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/source/ref/api.actual.rst b/docs/source/ref/api.actual.rst new file mode 100644 index 0000000..324a171 --- /dev/null +++ b/docs/source/ref/api.actual.rst @@ -0,0 +1,12 @@ +==================== +Actual Departure API +==================== + +.. automodule:: bvggrabber.api.actualdeparture + + + .. autodata:: ACTUAL_API_ENDPOINT + + + .. autoclass:: ActualDepartureQueryApi + :members: __init__, call 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 diff --git a/docs/source/ref/api.scheduled.rst b/docs/source/ref/api.scheduled.rst new file mode 100644 index 0000000..d167fb8 --- /dev/null +++ b/docs/source/ref/api.scheduled.rst @@ -0,0 +1,21 @@ +======================= +Scheduled Departure API +======================= + +.. automodule:: bvggrabber.api.scheduleddeparture + + + .. autodata:: SCHEDULED_API_ENDPOINT + + + .. autoclass:: ScheduledDepartureQueryApi + :members: __init__, call + + +Helper Classes +============== + + .. autoclass:: Vehicle + :members: + :undoc-members: + :private-members: \ No newline at end of file diff --git a/docs/source/ref/utils.format.rst b/docs/source/ref/utils.format.rst new file mode 100644 index 0000000..b4b588b --- /dev/null +++ b/docs/source/ref/utils.format.rst @@ -0,0 +1,24 @@ +==================== +Formatting Utilities +==================== + +.. automodule:: bvggrabber.utils.format + + +Functions +========= + +Time and Date related +--------------------- + + .. autofunction:: dateformat + + .. autofunction:: fullformat + + .. autofunction:: timeformat + + +Others +------ + + .. autofunction:: int2bin diff --git a/docs/source/ref/utils.json.rst b/docs/source/ref/utils.json.rst new file mode 100644 index 0000000..92bd70c --- /dev/null +++ b/docs/source/ref/utils.json.rst @@ -0,0 +1,18 @@ +=== +API +=== + +.. automodule:: bvggrabber.utils.json + + +General Functions +================= + + .. autofunction:: is_not_method + + +Classes +======= + + .. autoclass:: ObjectJSONEncoder + :members: default diff --git a/docs/source/ref/utils.rst b/docs/source/ref/utils.rst new file mode 100644 index 0000000..7fca500 --- /dev/null +++ b/docs/source/ref/utils.rst @@ -0,0 +1,10 @@ +===== +Utils +===== + +.. automodule:: bvggrabber.utils + + .. toctree:: + utils.format + utils.json + :maxdepth: 1 -- cgit v1.2.3