Skip to content

Commit 2e74fb0

Browse files
committed
cross link pages for queue_event_player score_queue_player and segment_display_player
1 parent bd679f1 commit 2e74fb0

File tree

6 files changed

+20
-15
lines changed

6 files changed

+20
-15
lines changed

docs/code/api_reference/config_players/queue_event_player.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Post queue events.
3030

3131
Validate one entry of this player.
3232

33-
## Config Reference:
33+
## Related Pages:
3434

3535
* [Queue Events](../../../events/overview/event_types.md#queue-events)
3636
* [queue_event_player: Config Reference](../../../config/queue_event_player.md)

docs/code/api_reference/config_players/score_queue_player.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# score_queue_player API Reference
22

3-
Config Reference:
4-
5-
* [score_queue_player:](../../../config/score_queue_player.md)
6-
73
`self.machine.score_queue_player`
84

95
``` python
@@ -37,3 +33,8 @@ Variable name.
3733
`validate_config_entry(settings: dict, name: str) → dict`
3834

3935
Validate one entry of this player.
36+
37+
## Related Pages:
38+
39+
* [How to implement solid state game style score queues](../../../game_logic/scoring/ss_style_score_queues.md)
40+
* [score_queue_player: Config Reference](../../../config/score_queue_player.md)

docs/code/api_reference/config_players/segment_display_player.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# segment_display_player API Reference
22

3-
Config Reference:
4-
5-
* [segment_display_player:](../../../config/segment_display_player.md)
6-
73
`self.machine.segment_display_player`
84

95
``` python
@@ -33,3 +29,8 @@ Parse express config.
3329
`play(settings, context, calling_context, priority=0, **kwargs)`
3430

3531
Show text on display.
32+
33+
## Related Pages:
34+
35+
* [segment_display_player: Config Reference](../../../config/segment_display_player.md)
36+
* [Segment Display player Config Player Reference](../../../config_players/segment_display_player.md)

docs/config/score_queue_player.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Single value, type: `integer` or `template`
4747

4848
Score value to add to the queue.
4949

50-
## Related How To guides
50+
## Related Pages:
5151

52-
* [How to implement solid state game style score queues in MPF](../game_logic/scoring/ss_style_score_queues.md)
52+
* [How to implement solid state game style score queues](../game_logic/scoring/ss_style_score_queues.md)
53+
* [score_queue_player API Reference](../code/api_reference/config_players/score_queue_player.md)

docs/config/segment_display_player.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,9 @@ There can only be one transition between text entries, so if outgoing
172172
text has a `transition_out` set, and an incoming text entry has a
173173
`transition` set, then the incoming transition will take precedence.
174174

175-
## Related How To guides
175+
## Related Pages:
176176

177177
* [Alpha-Numeric / Segment Displays](../mc/displays/alpha_numeric.md)
178178
* [Segment Display Platforms in MPF](../hardware/segment_display_platforms.md)
179+
* [segment_display_player API Reference](../code/api_reference/config_players/segment_display_player.md)
180+
* [Segment Display player Config Player Reference](../config_players/segment_display_player.md)

docs/config_players/segment_display_player.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In config files, the segment display player is used via the
1919
In shows, the segment display player is used via the `segment_displays:`
2020
section of a step.
2121

22-
## Config Options
22+
## Related Pages:
2323

24-
See [segment_display_player:](../config/segment_display_player.md) for
25-
config details.
24+
* [segment_display_player: Config Reference](../config/segment_display_player.md)
25+
* [segment_display_player API Reference](../code/api_reference/config_players/segment_display_player.md)

0 commit comments

Comments
 (0)