Skip to content

Commit 7874520

Browse files
committed
move api reference core index page to actual index route
this improves how the nav builds -- generating a clickable header instead of an expand-header that has a first item with the same name
1 parent 6c0de37 commit 7874520

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

docs/code/api_reference/api_reference_core.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Core Components
2+
3+
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.
4+
5+
* [auditor](auditor.md)
6+
* [ball_controller](ball_controller.md)
7+
* [bcp](bcp.md)
8+
* [device_manager](device_manager.md)
9+
* [events](events.md)
10+
* [info_lights](info_lights.md)
11+
* [light_controller](light_controller.md)
12+
* [machine](machine.md)
13+
* [mode_controller](mode_controller.md)
14+
* [placeholder_manager](placeholder_manager.md)
15+
* [platform_controller](platform_controller.md)
16+
* [service](service.md)
17+
* [settings](settings.md)
18+
* [show_controller](show_controller.md)
19+
* [switch_controller](switch_controller.md)
20+
* [switch_player](switch_player.md)
21+
* [text_ui](text_ui.md)
22+
* [twitch_bot](twitch_bot.md)

docs/code/api_reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
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

5-
* [Core Components](api_reference_core.md): MPF core components.
5+
* [Core Components](core/index.md): MPF core components.
66

77
* [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.
88

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1358,7 +1358,7 @@ nav:
13581358
- API Reference:
13591359
- code/api_reference/index.md
13601360
- Core:
1361-
- code/api_reference/api_reference_core.md
1361+
- code/api_reference/core/index.md
13621362
- code/api_reference/core/auditor.md
13631363
- code/api_reference/core/ball_controller.md
13641364
- code/api_reference/core/bcp.md

0 commit comments

Comments
 (0)