Skip to content

Commit 8ade9fb

Browse files
committed
move api reference index pages to index routes to improve nav structure generation
1 parent 7874520 commit 8ade9fb

File tree

14 files changed

+168
-169
lines changed

14 files changed

+168
-169
lines changed

docs/code/api_reference/api_reference_config_players.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/code/api_reference/api_reference_device.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

docs/code/api_reference/api_reference_hardware_platforms.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/code/api_reference/api_reference_misc_components.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/code/api_reference/api_reference_modes.md

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Config Players
2+
3+
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`.
4+
5+
* [blocking_player](blocking_player.md)
6+
* [coil_player](coil_player.md)
7+
* [event_player](event_player.md)
8+
* [flasher_player](flasher_player.md)
9+
* [hardware_sound_player](hardware_sound_player.md)
10+
* [light_player](light_player.md)
11+
* [queue_event_player](queue_event_player.md)
12+
* [queue_relay_player](queue_relay_player.md)
13+
* [random_event_player](random_event_player.md)
14+
* [score_queue_player](score_queue_player.md)
15+
* [segment_display_player](segment_display_player.md)
16+
* [show_player](show_player.md)
17+
* [variable_player](variable_player.md)

docs/code/api_reference/core/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Core Components
1+
# Core Components API Reference Index
22

33
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.
44

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Devices API Reference Index
2+
3+
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`.
4+
5+
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']`.
6+
7+
Note:
8+
9+
“Devices” in MPF are more than physical hardware devices. Many of the “game logic” components listed in the user documentation (achievements, ball holds, extra balls, etc.) are implemented as “devices” in MPF code. (So you can think of devices as being either physical or logical.)
10+
11+
Here's a list of all the device types in MPF, linked to their API references.
12+
13+
* [accelerometers](accelerometers.md)
14+
* [accruals](accruals.md)
15+
* [achievement_groups](achievement_groups.md)
16+
* [achievements](achievements.md)
17+
* [autofires](autofires.md)
18+
* [ball_devices](ball_devices.md)
19+
* [ball_holds](ball_holds.md)
20+
* [ball_routings](ball_routings.md)
21+
* [ball_saves](ball_saves.md)
22+
* [coils](coils.md)
23+
* [combo_switches](combo_switches.md)
24+
* [counters](counters.md)
25+
* [digital_outputs](digital_outputs.md)
26+
* [diverters](diverters.md)
27+
* [dmds](dmds.md)
28+
* [drop_target_banks](drop_target_banks.md)
29+
* [drop_targets](drop_targets.md)
30+
* [dual_wound_coils](dual_wound_coils.md)
31+
* [extra_ball_groups](extra_ball_groups.md)
32+
* [extra_balls](extra_balls.md)
33+
* [flippers](flippers.md)
34+
* [hardware_sound_systems](hardware_sound_systems.md)
35+
* [kickbacks](kickbacks.md)
36+
* [light_rings](light_rings.md)
37+
* [light_stripes](light_stripes.md)
38+
* [lights](lights.md)
39+
* [magnets](magnets.md)
40+
* [motors](motors.md)
41+
* [multiball_locks](multiball_locks.md)
42+
* [multiballs](multiballs.md)
43+
* [playfield_transfers](playfield_transfers.md)
44+
* [playfields](playfields.md)
45+
* [psus](psus.md)
46+
* [rgb_dmds](rgb_dmds.md)
47+
* [score_queues](score_queues.md)
48+
* [score_reel_groups](score_reel_groups.md)
49+
* [score_reels](score_reels.md)
50+
* [segment_displays](segment_displays.md)
51+
* [sequence_shots](sequence_shots.md)
52+
* [sequences](sequences.md)
53+
* [servos](servos.md)
54+
* [shot_groups](shot_groups.md)
55+
* [shot_profiles](shot_profiles.md)
56+
* [shots](shots.md)
57+
* [show_queues](show_queues.md)
58+
* [state_machines](state_machines.md)
59+
* [steppers](steppers.md)
60+
* [switches](switches.md)
61+
* [timed_switches](timed_switches.md)
62+
* [timers](timers.md)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Hardware Platforms
2+
3+
Hardware platforms are stored in a machine hardware_platforms dictionary, for example, `self.machine.hardware_platforms['fast']` or `self.machine.hardware_platforms['p_roc']`.
4+
5+
* [drivers](drivers.md)
6+
* [fadecandy](fadecandy.md)
7+
* [fast](fast.md)
8+
* [i2c_servo_controller](i2c_servo_controller.md)
9+
* [light_segment_displays](light_segment_displays.md)
10+
* [lisy](lisy.md)
11+
* [mma8451](mma8451.md)
12+
* [mypinballs](mypinballs.md)
13+
* [openpixel](openpixel.md)
14+
* [opp](opp.md)
15+
* [osc](osc.md)
16+
* [p3_roc](p3_roc.md)
17+
* [p_roc](p_roc.md)
18+
* [pin2dmd](pin2dmd.md)
19+
* [pololu_maestro](pololu_maestro.md)
20+
* [pololu_tic](pololu_tic.md)
21+
* [rpi](rpi.md)
22+
* [rpi_dmd](rpi_dmd.md)
23+
* [smart_virtual](smart_virtual.md)
24+
* [smartmatrix](smartmatrix.md)
25+
* [smbus2](smbus2.md)
26+
* [snux](snux.md)
27+
* [spi_bit_bang](spi_bit_bang.md)
28+
* [spike](spike.md)
29+
* [step_stick](step_stick.md)
30+
* [system11](system11.md)
31+
* [trinamics_steprocker](trinamics_steprocker.md)
32+
* [virtual](virtual.md)
33+
* [virtual_pinball](virtual_pinball.md)
34+
* [visual_pinball_evolution](visual_pinball_evolution.md)

docs/code/api_reference/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# API Reference
1+
# API Reference Index
22

33
MPF's API reference is broken into several categories. All of it is presented in the way that the modules and classes are actually used in MPF.
44

55
* [Core Components](core/index.md): MPF core components.
66

7-
* [Devices](api_reference_device.md): MPF devices, including physical devices like flippers, ball devices, switches, lights, etc. as well as logical devices like ball saves, extra balls, multiballs, etc.
7+
* [Devices](devices/index.md): MPF devices, including physical devices like flippers, ball devices, switches, lights, etc. as well as logical devices like ball saves, extra balls, multiballs, etc.
88

9-
* [Modes](api_reference_modes.md): Built-in modes, such as game, attract, tilt, credits, etc.
9+
* [Modes](modes/index.md): Built-in modes, such as game, attract, tilt, credits, etc.
1010

11-
* [Platforms](api_reference_hardware_platforms.md): Hardware platforms interfacess for all supported hardware.
11+
* [Platforms](hardware_platforms/index.md): Hardware platforms interfacess for all supported hardware.
1212

13-
* [Config Players](api_reference_config_players.md): Modules responsible for all config players (show_player, light_player, score_player, etc.)
13+
* [Config Players](config_players/index.md): Modules responsible for all config players (show_player, light_player, score_player, etc.)
1414

15-
* [Tests](api_reference_testing_class_api.md): All unit test base classes for writing tests for MPF and your own game.
15+
* [Tests](testing_class_api/index.md): All unit test base classes for writing tests for MPF and your own game.
1616

17-
* [Miscellaneous Components](api_reference_misc_components.md): Things that don't fit into other categories, including utility functions, the base classes for modes, players, timers, and other utility functions.
17+
* [Miscellaneous Components](misc_components/index.md): Things that don't fit into other categories, including utility functions, the base classes for modes, players, timers, and other utility functions.

0 commit comments

Comments
 (0)