add more links from api reference pages to config references

bosh · bosh · commit 7abd9c34e4a0 · 2025-07-09T02:16:52.000-07:00
diff --git a/docs/code/api_reference/core/auditor.md b/docs/code/api_reference/core/auditor.md
@@ -1,5 +1,9 @@
 # auditor API Reference
 
+Config Reference:
+
+* [auditor:](../../../config/auditor.md)
+
 `self.machine.auditor`
 
 ``` python
diff --git a/docs/code/api_reference/core/bcp.md b/docs/code/api_reference/core/bcp.md
@@ -1,5 +1,9 @@
 # bcp API Reference
 
+Config Reference:
+
+* [bcp:](../../../config/bcp.md)
+
 `self.machine.bcp`
 
 ``` python
diff --git a/docs/code/api_reference/core/info_lights.md b/docs/code/api_reference/core/info_lights.md
@@ -1,5 +1,9 @@
 # info_lights API Reference
 
+Config Reference:
+
+* [info_lights:](../../../config/info_lights.md)
+
 `self.machine.info_lights`
 
 ``` python
diff --git a/docs/code/api_reference/core/machine.md b/docs/code/api_reference/core/machine.md
@@ -1,5 +1,9 @@
 # machine API Reference
 
+Config Reference:
+
+* [machine:](../../../config/machine.md)
+
 `self.machine`
 
 ``` python
diff --git a/docs/code/api_reference/core/settings.md b/docs/code/api_reference/core/settings.md
@@ -1,5 +1,9 @@
 # settings API Reference
 
+Config Reference:
+
+* [settings:](../../../config/settings.md)
+
 `self.machine.settings`
 
 ``` python
diff --git a/docs/code/api_reference/core/switch_player.md b/docs/code/api_reference/core/switch_player.md
@@ -1,5 +1,9 @@
 # switch_player API Reference
 
+Config Reference:
+
+* [switch_player:](../../../config/switch_player.md)
+
 `self.machine.switch_player`
 
 ``` python
diff --git a/docs/code/api_reference/core/text_ui.md b/docs/code/api_reference/core/text_ui.md
@@ -1,5 +1,9 @@
 # text_ui API Reference
 
+Config Reference:
+
+* [text_ui:](../../../config/text_ui.md)
+
 `self.machine.text_ui`
 
 ``` python
diff --git a/docs/code/api_reference/core/twitch_bot.md b/docs/code/api_reference/core/twitch_bot.md
@@ -1,5 +1,9 @@
 # twitch_bot API Reference
 
+Config Reference:
+
+* [twitch_client:](../../../config/twitch_client.md)
+
 `self.machine.twitch_bot`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/fadecandy.md b/docs/code/api_reference/hardware_platforms/fadecandy.md
@@ -1,5 +1,9 @@
 # fadecandy API Reference
 
+Config Reference:
+
+* [fadecandy:](../../../config/fadecandy.md)
+
 `self.machine.hardware_platforms['fadecandy']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/fast.md b/docs/code/api_reference/hardware_platforms/fast.md
@@ -1,5 +1,9 @@
 # fast API Reference
 
+Config Reference:
+
+* [fast:](../../../config/fast.md)
+
 `self.machine.hardware_platforms['fast']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/light_segment_displays.md b/docs/code/api_reference/hardware_platforms/light_segment_displays.md
@@ -1,5 +1,9 @@
 # light_segment_displays API Reference
 
+Config Reference:
+
+* [light_segment_displays:](../../../config/light_segment_displays.md)
+
 `self.machine.hardware_platforms['light_segment_displays']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/lisy.md b/docs/code/api_reference/hardware_platforms/lisy.md
@@ -1,5 +1,9 @@
 # lisy API Reference
 
+Config Reference:
+
+* [lisy:](../../../config/lisy.md)
+
 `self.machine.hardware_platforms['lisy']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/mypinballs.md b/docs/code/api_reference/hardware_platforms/mypinballs.md
@@ -1,5 +1,9 @@
 # mypinballs API Reference
 
+Config Reference:
+
+* [mypinballs:](../../../config/mypinballs.md)
+
 `self.machine.hardware_platforms['mypinballs']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/openpixel.md b/docs/code/api_reference/hardware_platforms/openpixel.md
@@ -1,5 +1,9 @@
 # openpixel API Reference
 
+Config Reference:
+
+* [open_pixel_control:](../../../config/open_pixel_control.md)
+
 `self.machine.hardware_platforms['openpixel']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/opp.md b/docs/code/api_reference/hardware_platforms/opp.md
@@ -1,5 +1,9 @@
 # opp API Reference
 
+Config Reference:
+
+* [opp:](../../../config/opp.md)
+
 `self.machine.hardware_platforms['opp']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/osc.md b/docs/code/api_reference/hardware_platforms/osc.md
@@ -1,5 +1,9 @@
 # osc API Reference
 
+Config Reference:
+
+* [osc:](../../../config/osc.md)
+
 `self.machine.hardware_platforms['osc']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/p_roc.md b/docs/code/api_reference/hardware_platforms/p_roc.md
@@ -1,5 +1,9 @@
 # p_roc API Reference
 
+Config Reference:
+
+* [p_roc:](../../../config/p_roc.md)
+
 `self.machine.hardware_platforms['p_roc']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/pin2dmd.md b/docs/code/api_reference/hardware_platforms/pin2dmd.md
@@ -1,5 +1,9 @@
 # pin2dmd API Reference
 
+Config Reference:
+
+* [pin2dmd:](../../../config/pin2dmd.md)
+
 `self.machine.hardware_platforms['pin2dmd']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/pololu_tic.md b/docs/code/api_reference/hardware_platforms/pololu_tic.md
@@ -1,5 +1,9 @@
 # pololu_tic API Reference
 
+Config Reference:
+
+* [pololu_tic:](../../../config/pololu_tic.md)
+
 `self.machine.hardware_platforms['pololu_tic']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/rpi_dmd.md b/docs/code/api_reference/hardware_platforms/rpi_dmd.md
@@ -1,5 +1,9 @@
 # rpi_dmd API Reference
 
+Config Reference:
+
+* [rpi_dmd:](../../../config/rpi_dmd.md)
+
 `self.machine.hardware_platforms['rpi_dmd']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/smart_virtual.md b/docs/code/api_reference/hardware_platforms/smart_virtual.md
@@ -1,5 +1,9 @@
 # smart_virtual API Reference
 
+Config Reference:
+
+* [smart_virtual:](../../../config/smart_virtual.md)
+
 `self.machine.hardware_platforms['smart_virtual']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/smartmatrix.md b/docs/code/api_reference/hardware_platforms/smartmatrix.md
@@ -1,5 +1,9 @@
 # smartmatrix API Reference
 
+Config Reference:
+
+* [smartmatrix:](../../../config/smartmatrix.md)
+
 `self.machine.hardware_platforms['smartmatrix']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/snux.md b/docs/code/api_reference/hardware_platforms/snux.md
@@ -1,5 +1,9 @@
 # snux API Reference
 
+Config Reference:
+
+* [snux:](../../../config/snux.md)
+
 `self.machine.hardware_platforms['snux']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/spike.md b/docs/code/api_reference/hardware_platforms/spike.md
@@ -1,5 +1,9 @@
 # spike API Reference
 
+Config Reference:
+
+* [spike:](../../../config/spike.md)
+
 `self.machine.hardware_platforms['spike']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/step_stick.md b/docs/code/api_reference/hardware_platforms/step_stick.md
@@ -1,5 +1,9 @@
 # step_stick API Reference
 
+Config Reference:
+
+* [step_stick_stepper_settings:](../../../config/step_stick_stepper_settings.md)
+
 `self.machine.hardware_platforms['step_stick']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/system11.md b/docs/code/api_reference/hardware_platforms/system11.md
@@ -1,5 +1,9 @@
 # system11 API Reference
 
+Config Reference:
+
+* [system11:](../../../config/system11.md)
+
 `self.machine.hardware_platforms['system11']`
 
 ``` python
diff --git a/docs/code/api_reference/hardware_platforms/trinamics_steprocker.md b/docs/code/api_reference/hardware_platforms/trinamics_steprocker.md
@@ -1,5 +1,9 @@
 # trinamics_steprocker API Reference
 
+Config Reference:
+
+* [trinamics_steprocker:](../../../config/trinamics_steprocker.md)
+
 `self.machine.hardware_platforms['trinamics_steprocker']`
 
 ``` python
diff --git a/docs/code/api_reference/misc_components/BallSearch.md b/docs/code/api_reference/misc_components/BallSearch.md
@@ -1,5 +1,9 @@
 # Ball Search API Reference
 
+Config Reference:
+
+* [playfields:enable_ball_search](../../../config/playfields.md#enable_ball_search)
+
 ``` python
 class mpf.core.ball_search.BallSearch(machine: mpf.core.machine.MachineController, playfield: Playfield)
 ```
diff --git a/docs/code/api_reference/misc_components/LogMixin.md b/docs/code/api_reference/misc_components/LogMixin.md
@@ -1,5 +1,9 @@
 # LogMixin API Reference
 
+Config Reference:
+
+* [logging:](../../../config/logging.md)
+
 ``` python
 class mpf.core.logging.LogMixin
 ```
diff --git a/docs/code/api_reference/misc_components/ModeBaseClass.md b/docs/code/api_reference/misc_components/ModeBaseClass.md
@@ -1,5 +1,9 @@
 # Mode base class API Reference
 
+Config Reference:
+
+* [mode_settings:](../../../config/mode_settings.md)
+
 ``` python
 class mpf.core.mode.Mode(machine: MachineController, config, name: str, path, asset_paths)
 ```
diff --git a/docs/code/api_reference/misc_components/Players.md b/docs/code/api_reference/misc_components/Players.md
@@ -1,5 +1,9 @@
 # Player API Reference
 
+Config Reference:
+
+* [player_vars:](../../../config/player_vars.md)
+
 ``` python
 class mpf.core.player.Player(machine, index)
 ```
diff --git a/docs/code/api_reference/modes/bonus.md b/docs/code/api_reference/modes/bonus.md
@@ -1,5 +1,10 @@
 # Bonus Mode API Reference
 
+Config Reference:
+
+* [bonus (mode_settings:)](../../../config/bonus.md)
+* [Bonus Mode Configuration *(GMC/0.80+)*](../../../gmc/reference/bonus.md)
+
 `self.machine.modes.bonus`
 
 ``` python
diff --git a/docs/code/api_reference/modes/carousel.md b/docs/code/api_reference/modes/carousel.md
@@ -1,5 +1,9 @@
 # Carousel Mode API Reference
 
+Reference:
+
+* [MPFCarousel *(GMC/0.80+)*](../../../gmc/reference/mpf-carousel.md)
+
 `self.machine.modes.carousel`
 
 ``` python
diff --git a/docs/code/api_reference/modes/credits.md b/docs/code/api_reference/modes/credits.md
@@ -1,5 +1,9 @@
 # Credits Mode API Reference
 
+Config Reference:
+
+* [credits:](../../../config/credits.md)
+
 `self.machine.modes.credits`
 
 ``` python
diff --git a/docs/code/api_reference/modes/game.md b/docs/code/api_reference/modes/game.md
@@ -1,5 +1,9 @@
 # Game Mode API Reference
 
+Config Reference:
+
+* [game:](../../../config/game.md)
+
 `self.machine.modes.game`
 
 ``` python
diff --git a/docs/code/api_reference/modes/high_score.md b/docs/code/api_reference/modes/high_score.md
@@ -1,5 +1,9 @@
 # High Score Mode API Reference
 
+Config Reference:
+
+* [high_score:](../../../config/high_score.md)
+
 `self.machine.modes.high_score`
 
 ``` python
diff --git a/docs/code/api_reference/modes/tilt.md b/docs/code/api_reference/modes/tilt.md
@@ -1,5 +1,9 @@
 # Tilt Mode API Reference
 
+Config Reference:
+
+* [tilt:](../../../config/tilt.md)
+
 `self.machine.modes.tilt`
 
 ``` python
