Added information about, webGetRoutes, webGetStops, sidebar now has t…

…he table of contents
gph03n1x · Jul 13, 2016 · 2fb0b7b · 2fb0b7b
1 parent e50738e
commit 2fb0b7b
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 5 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -176,7 +176,7 @@
 # Custom sidebar templates, maps document names to template names.
 #
 # html_sidebars = {}
-
+html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'], }
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,14 +19,14 @@ Actions:
    webGetLinesWithMLInfo
    webGetRoutes
    webGetStops
-   getStopArrivals
-   getBusLocation
    webRouteDetails
    webRoutesForStop
+   webGetRoutesDetailsAndStops
+   getStopArrivals
+   getBusLocation
    getScheduleDaysMasterline
    getLinesAndRoutesForMl
    getRoutesForLine
-   webGetRoutesDetailsAndStops
    getMLName
    getLineName
    getRouteName

diff --git a/docs/source/webGetLines.rst b/docs/source/webGetLines.rst
@@ -5,7 +5,6 @@ webGetLines
 
 **Api Endpoint:**
 
-
 ``http://telematics.oasa.gr/api/?act=webGetLines``
 
 **Response:**

diff --git a/docs/source/webGetRoutes.rst b/docs/source/webGetRoutes.rst
@@ -1,2 +1,38 @@
 webGetRoutes
 ============
+
+Επιστρέφει τις διαδρομές σχετικά με την διαδρομή μιας γραμμής.
+Για να χρησιμοποιηθεί χρειαζόμαστε και την παράμετρο *linecode* που μπορούμε να
+την βρούμε αν φιλτράρουμε τον αριθμό του λεωφορείου που χρειαζόμαστε από τις
+δράσεις webGetLines και webGetLinesWithMLInfo
+
+Για παράδειγμα το Α1 (linecode=962) που είναι η γραμμή ΠΕΙΡΑΙΑΣ-ΒΟΥΛΑ , έχει διαδρομές
+ΠΕΙΡΑΙΑΣ-ΒΟΥΛΑ και ΒΟΥΛΑ-ΠΕΙΡΑΙΑΣ.
+
+
+**Api Endpoint:**
+
+``http://telematics.oasa.gr/api/?act=webGetRoutes&p1=linecode``
+
+**Response:**
+
+.. code-block:: python
+
+   [
+   {
+   "RouteCode":"2045",
+   "LineCode":"962",
+   "RouteDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3 - \u0392\u039f\u03a5\u039b\u0391",
+   "RouteDescrEng":"PEIRAIAS - VOULA",
+   "RouteType":"1",
+   "RouteDistance":"22385.44"
+   },
+   {
+   "RouteCode":"2046",
+   "LineCode":"962",
+   "RouteDescr":"\u0392\u039f\u03a5\u039b\u0391 - \u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3",
+   "RouteDescrEng":"VOULA - PEIRAIAS",
+   "RouteType":"2",
+   "RouteDistance":"22644.61"
+   }
+   ]
diff --git a/docs/source/webGetStops.rst b/docs/source/webGetStops.rst
@@ -1,2 +1,32 @@
 webGetStops
 ===========
+
+Επιστρέφει τις στάσεις μιας διαδρομής. Χρειαζόμαστε και μια παράμετρο που είναι
+το *routecode* δηλαδή ο κώδικας μιας διαδρομής . Στο παράδειγμα εμφανίζεται η πρώτη
+στάση της διαδρομής ΠΕΙΡΑΙΑΣ-ΒΟΥΛΑ (routecode=2045)
+
+**Api Endpoint:**
+
+``http://telematics.oasa.gr/api/?act=webGetStops&p1=routecode``
+
+**Response:**
+
+.. code-block:: python
+
+   [
+   {
+   "StopCode":"10183",
+   "StopID":"25",
+   "StopDescr":"\u03a0\u0395\u0399\u03a1\u0391\u0399\u0391\u03a3",
+   "StopDescrEng":"PEIRAIAS",
+   "StopStreet":null,
+   "StopStreetEng":null,
+   "StopHeading":"93",
+   "StopLat":"37.938246",
+   "StopLng":"23.6320605",
+   "RouteStopOrder":"1",
+   "StopType":"0",
+   "StopAmea":"0"
+   },
+   ....
+   ]