Merge pull request #606 from bosh/api_nav

API Reference section rework

Author: bosh

docs/code/api_reference/api_reference_config_players.md

@@ -1,7 +1,6 @@
-
 # Config Players
 
-Config players are available as machine attributes in the form of their player name plus _player, for example, self.machine.light_player or self.machine.score_player.
+Config players are available as machine attributes in the form of their player name plus \_player, for example, `self.machine.light_player` or `self.machine.score_player`.
 
 * [blocking_player](config_players/blocking_player.md)
 * [coil_player](config_players/coil_player.md)
@@ -16,5 +15,3 @@ Config players are available as machine attributes in the form of their player n
 * [segment_display_player](config_players/segment_display_player.md)
 * [show_player](config_players/show_player.md)
 * [variable_player](config_players/variable_player.md)
-
-

docs/code/api_reference/api_reference_core.md

@@ -1,6 +1,6 @@
 # Core Components
 
-Core MPF machine components, accessible to programmers at self.machine.*name*. For example, the ball controller is at self.machine.ball_controller, the event manager is self.machine.events, etc.
+Core MPF machine components, accessible to programmers at `self.machine.*name*`. For example, the ball controller is at `self.machine.ball_controller`, the event manager is `self.machine.events`, etc.
 
 * [auditor](core/auditor.md)
 * [ball_controller](core/ball_controller.md)
@@ -20,4 +20,3 @@ Core MPF machine components, accessible to programmers at self.machine.*name*. F
 * [switch_player](core/switch_player.md)
 * [text_ui](core/text_ui.md)
 * [twitch_bot](core/twitch_bot.md)
-

docs/code/api_reference/api_reference_device.md

@@ -1,9 +1,8 @@
-
 # Devices
 
-Instances of MPF devices, available at self.machine.*device_collection*.*device_name*. For example, a flipper device called “right_flipper” is at self.machine.flippers.right_flipper, and a multiball called “awesome” is accessible at self.machine.multiballs.awesome.
+Instances of MPF devices, available at `self.machine.*device_collection*.*device_name*`. For example, a flipper device called “right_flipper” is at `self.machine.flippers.right_flipper`, and a multiball called “awesome” is accessible at `self.machine.multiballs.awesome`.
 
-Note that device collections are accessible as attributes and items, so the right flipper mentioned above is also available to programmers at self.machine.flippers['right_flipper'].
+Note that device collections are accessible as attributes and items, so the right flipper mentioned above is also available to programmers at `self.machine.flippers['right_flipper']`.
 
 Note
 
@@ -61,5 +60,3 @@ Here’s a list of all the device types in MPF, linked to their API references.
 * [switches](devices/switches.md)
 * [timed_switches](devices/timed_switches.md)
 * [timers](devices/timers.md)
-
-

docs/code/api_reference/api_reference_hardware_platforms.md

@@ -1,7 +1,6 @@
-
 # Hardware Platforms
 
-Hardware platforms are stored in a machine hardware_platforms dictionary, for example, self.machine.hardware_platforms['fast'] or self.machine.hardware_platforms['p_roc'].
+Hardware platforms are stored in a machine hardware_platforms dictionary, for example, `self.machine.hardware_platforms['fast']` or `self.machine.hardware_platforms['p_roc']`.
 
 * [drivers](hardware_platforms/drivers.md)
 * [fadecandy](hardware_platforms/fadecandy.md)
@@ -33,5 +32,3 @@ Hardware platforms are stored in a machine hardware_platforms dictionary, for ex
 * [virtual](hardware_platforms/virtual.md)
 * [virtual_pinball](hardware_platforms/virtual_pinball.md)
 * [visual_pinball_evolution](hardware_platforms/visual_pinball_evolution.md)
-
-

docs/code/api_reference/api_reference_misc_components.md

@@ -1,4 +1,3 @@
-
 # Miscellaneous Components
 
 There are several other components and systems of MPF that don’t fit into any of the other categories. Those are covered here.

docs/code/api_reference/api_reference_modes.md

@@ -1,7 +1,6 @@
-
 # Modes
 
-Covers all the “built-in” modes. They’re accessible via self.machine.modes.*name*, for example, self.machine.modes.game or self.machine.modes.base.
+Covers all the “built-in” modes. They’re accessible via `self.machine.modes.*name*`, for example, `self.machine.modes.game` or `self.machine.modes.base`.
 
 * [attract](modes/attract.md)
 * [bonus](modes/bonus.md)

docs/code/api_reference/api_reference_testing_class_api.md

@@ -1,4 +1,3 @@
-
 # Testing Class API
 
 MPF includes several unit test classes which you can use to write tests which test MPF or to write tests for your own game.

docs/code/api_reference/config_players/blocking_player.md

@@ -1,9 +1,12 @@
+# blocking_player API Reference
 
-# self.machine.blocking_player
+`self.machine.blocking_player`
 
-`class mpf.config_players.block_event_player.BlockEventPlayer(machine)`
+``` python
+class mpf.config_players.block_event_player.BlockEventPlayer(machine)
+```
 
-Bases: mpf.core.config_player.ConfigPlayer
+Bases: `mpf.core.config_player.ConfigPlayer`
 
 Posts events based on config.
 
@@ -26,4 +29,3 @@ Block event.
 `validate_config_entry(settings: dict, name: str) → dict`
 
 Validate one entry of this player.
-

docs/code/api_reference/config_players/coil_player.md

@@ -1,9 +1,12 @@
+# coil_player API Reference
 
-# self.machine.coil_player
+`self.machine.coil_player`
 
-`class mpf.config_players.coil_player.CoilPlayer(machine)`
+``` python
+class mpf.config_players.coil_player.CoilPlayer(machine)
+```
 
-Bases: mpf.config_players.device_config_player.DeviceConfigPlayer
+Bases: `mpf.config_players.device_config_player.DeviceConfigPlayer`
 
 Triggers coils based on config.
 
@@ -26,4 +29,3 @@ Parse short config version.
 ` play(settings, context: str, calling_context: str, priority: int = 0, **kwargs)`
 
 Enable, Pulse or disable coils.
-

docs/code/api_reference/config_players/event_player.md

@@ -1,9 +1,12 @@
+# event_player API Reference
 
-# self.machine.event_player
+`self.machine.event_player`
 
-`class mpf.config_players.event_player.EventPlayer(machine)`
+``` python
+class mpf.config_players.event_player.EventPlayer(machine)
+```
 
-Bases: mpf.config_players.flat_config_player.FlatConfigPlayer
+Bases: `mpf.config_players.flat_config_player.FlatConfigPlayer`
 
 Posts events based on config.
 
@@ -26,4 +29,3 @@ Parse list.
 `play(settings, context, calling_context, priority=0, **kwargs)`
 
 Post (delayed) events.
-