Documentation prepared and improved

wiki/classes/BoardArrival.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/BoardDeparture.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Channel.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/Client.md

@@ -0,0 +1,31 @@
+# Client
+
+You are now viewing the main class of the module, all available higher-level methods can be found here.  
+
+This page is about the Client class, which exposes high-level methods for an easy access to the API.
+
+```py
+from pyrmv import Client
+
+client = Client("SampleAPIKey")
+
+print(client.stop_by_id("A=1@O=Offenbach (Main)-Zentrum Marktplatz\/Frankf. Straße@X=8764456@Y=50105181@U=80@L=3002510@"))
+```
+
+## Details
+
+### Parameters
+
+* access_key (`str`) – Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html).
+
+### Methods
+
+* [board_arrival](https://git.end-play.xyz/profitroll/PythonRMV/wiki/board_arrival) -> `BoardArrival`
+* [board_departure](https://git.end-play.xyz/profitroll/PythonRMV/wiki/board_departure) -> `BoardDeparture`
+* [him_search](https://git.end-play.xyz/profitroll/PythonRMV/wiki/him_search) -> `List[Message]`
+* [journey_detail](https://git.end-play.xyz/profitroll/PythonRMV/wiki/journey_detail) -> `Journey`
+* [stop_by_coords](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_coords) -> `List[Stop]`
+* [stop_by_id](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_id) -> `Union[Stop, None]`
+* [stop_by_name](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_name) -> `List[Stop]`
+* [trip_find](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_find) -> `List[Trip]`
+* [trip_recon](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_recon) -> `List[Trip]`

wiki/classes/Client/methods/Client.board_arrival.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.board_departure.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.him_search.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.journey_detail.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.stop_by_coords.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.stop_by_id.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.stop_by_name.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.trip_find.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Client/methods/Client.trip_recon.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Gis.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Journey.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Leg.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/LineArrival.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/LineDeparture.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Message.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Stop.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/StopTrip.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Ticket.md

@@ -0,0 +1 @@
+Class is not available yet. Documentation will appear here after the class is finished.

wiki/classes/Trip.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.

wiki/classes/Url.md

@@ -0,0 +1 @@
+Docs are not available yet. Please, use the linting in your IDE until the documentation is there.